logo

Back to Help Home Page.

GET Api/Reports?page={page}&pageSize={pageSize}&reference={reference}&officeId={officeId}&scheduledOnFrom={scheduledOnFrom}&scheduledOnTo={scheduledOnTo}&type={type}&flowStatus={flowStatus}&executedOnFrom={executedOnFrom}&executedOnTo={executedOnTo}&modifiedSince={modifiedSince}

Retrieves reports linked to provided login/business.

Request Information

URI Parameters

NameDescriptionTypeAdditional information

page

Optional: The page to retrieve.

integer

Default value is 0

pageSize

Optional: The number of estates on one page.

integer

Default value is 100

reference

Optional: the report reference.

string

None.

officeId

Optional: the officeId the report is linked to.

integer

None.

scheduledOnFrom

Optional: only get reports scheduled from this date.

date

None.

scheduledOnTo

Optional: only get reports scheduled until this date.

date

None.

type

Optional: only get reports of specified type.

string

None.

flowStatus

Optional: only get reports of specified flow status.

string

None.

executedOnFrom

Optional: only get reports executed from this date.

date

None.

executedOnTo

Optional: only get reports executed until this date.

date

None.

modifiedSince

Optional: only get reports modified since this date.

date

None.

Body Parameters

None.

Response Information

Resource Description

A paged list of report summaries.

Collection of ChappReport.Site.Areas.Api.Models.V1.ReportSummaryV1ModelResponse
NameDescriptionTypeAdditional information

Id

The Chapps identifier of the report.

integer

None.

Reference

The reference of the broker,expert,... This will be shown on the report.

string

None.

Type

Type of the report. Possible values: Initialization, MovingIn, CheckUp, PreMoveOut, MovingOut, Renovation, VacancyCheckUp, PreWork*, ConcessionMovingIn*, ConcessionMovingOut* (*Only available if the user has the required product)

string

None.

Url

Returns a direct link where the report detail information can be retrieved.

string

None.

FlowStatus

The current status of the report. Possible values are ToBeAssigned, Initiated, ReadyForSyncToApp, ReceivedByApp, InProgress, CancelledByExecutor, RecallByOperator, BlockedBySignature, PostProcessing, Completed

string

None.

Estate

The estate of the report

ChappReport.Site.Areas.Api.Models.V1.EstateV1ModelResponse

None.

ExecutedOn

The date of execution of the inspection.

date

None.

ExecutorId

The ID of the executor of the inspection

integer

None.

Modified

The last modification date of the report.

date

None.

History

Collection of ChappReport.Site.Areas.Api.Models.V1.ReportHistoryItemV1Model

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": 1,
    "Reference": "MyReportRef1",
    "Type": "MovingIn",
    "Url": "http://rental.chapps.com/api/Reports/1",
    "FlowStatus": "Completed",
    "Estate": {
      "Id": 1,
      "Url": "https://rental.chapps.com/api/Estates/1",
      "Reference": "MyObjectRef2",
      "Address": {
        "Street": "Ruschestrasse",
        "HouseNumber": 45,
        "ZipCode": "23957",
        "City": "Wismar",
        "Country": "DE"
      },
      "Type": "Studio"
    },
    "ExecutedOn": "2026-07-10T06:00:02",
    "Modified": "2026-07-12T06:00:02",
    "History": [
      {
        "FlowStatus": "Draft",
        "CreatedOn": "2026-07-08T06:00:02.3837575+02:00"
      },
      {
        "FlowStatus": "ReadyForSyncToApp",
        "CreatedOn": "2026-07-09T06:00:02.3837575+02:00"
      },
      {
        "FlowStatus": "InProgress",
        "CreatedOn": "2026-07-10T06:00:02.3837575+02:00"
      },
      {
        "FlowStatus": "PostProcessing",
        "CreatedOn": "2026-07-11T06:00:02.3837575+02:00"
      },
      {
        "FlowStatus": "Completed",
        "CreatedOn": "2026-07-12T06:00:02.3837575+02:00"
      }
    ]
  },
  {
    "Id": 1,
    "Reference": "MyReportRef2",
    "Type": "CheckUp",
    "Url": "http://rental.chapps.com/api/Reports/2",
    "FlowStatus": "Draft",
    "Estate": {
      "Id": 1,
      "Url": "https://rental.chapps.com/api/Estates/1",
      "Reference": "MyObjectRef2",
      "Address": {
        "Street": "Ruschestrasse",
        "HouseNumber": 45,
        "ZipCode": "23957",
        "City": "Wismar",
        "Country": "DE"
      },
      "Type": "Studio"
    },
    "Modified": "2026-07-11T06:00:02",
    "History": [
      {
        "FlowStatus": "Draft",
        "CreatedOn": "2026-07-11T06:00:02.3837575+02:00"
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfReportSummaryV1ModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <ReportSummaryV1ModelResponse>
    <Estate>
      <Address>
        <City>Wismar</City>
        <Country>DE</Country>
        <HouseNumber>45</HouseNumber>
        <HouseNumberExtension i:nil="true" />
        <Mailbox i:nil="true" />
        <State i:nil="true" />
        <Street>Ruschestrasse</Street>
        <ZipCode>23957</ZipCode>
      </Address>
      <EstateGroupId i:nil="true" />
      <OfficeId i:nil="true" />
      <PartnerReference i:nil="true" />
      <Reference>MyObjectRef2</Reference>
      <Type>Studio</Type>
      <Id>1</Id>
      <Url>https://rental.chapps.com/api/Estates/1</Url>
    </Estate>
    <ExecutedOn>2026-07-10T06:00:02</ExecutedOn>
    <ExecutorId i:nil="true" />
    <FlowStatus>Completed</FlowStatus>
    <History>
      <ReportHistoryItemV1Model>
        <CreatedOn>2026-07-08T06:00:02.3837575+02:00</CreatedOn>
        <FlowStatus>Draft</FlowStatus>
      </ReportHistoryItemV1Model>
      <ReportHistoryItemV1Model>
        <CreatedOn>2026-07-09T06:00:02.3837575+02:00</CreatedOn>
        <FlowStatus>ReadyForSyncToApp</FlowStatus>
      </ReportHistoryItemV1Model>
      <ReportHistoryItemV1Model>
        <CreatedOn>2026-07-10T06:00:02.3837575+02:00</CreatedOn>
        <FlowStatus>InProgress</FlowStatus>
      </ReportHistoryItemV1Model>
      <ReportHistoryItemV1Model>
        <CreatedOn>2026-07-11T06:00:02.3837575+02:00</CreatedOn>
        <FlowStatus>PostProcessing</FlowStatus>
      </ReportHistoryItemV1Model>
      <ReportHistoryItemV1Model>
        <CreatedOn>2026-07-12T06:00:02.3837575+02:00</CreatedOn>
        <FlowStatus>Completed</FlowStatus>
      </ReportHistoryItemV1Model>
    </History>
    <Id>1</Id>
    <Modified>2026-07-12T06:00:02</Modified>
    <Reference>MyReportRef1</Reference>
    <Type>MovingIn</Type>
    <Url>http://rental.chapps.com/api/Reports/1</Url>
  </ReportSummaryV1ModelResponse>
  <ReportSummaryV1ModelResponse>
    <Estate>
      <Address>
        <City>Wismar</City>
        <Country>DE</Country>
        <HouseNumber>45</HouseNumber>
        <HouseNumberExtension i:nil="true" />
        <Mailbox i:nil="true" />
        <State i:nil="true" />
        <Street>Ruschestrasse</Street>
        <ZipCode>23957</ZipCode>
      </Address>
      <EstateGroupId i:nil="true" />
      <OfficeId i:nil="true" />
      <PartnerReference i:nil="true" />
      <Reference>MyObjectRef2</Reference>
      <Type>Studio</Type>
      <Id>1</Id>
      <Url>https://rental.chapps.com/api/Estates/1</Url>
    </Estate>
    <ExecutedOn i:nil="true" />
    <ExecutorId i:nil="true" />
    <FlowStatus>Draft</FlowStatus>
    <History>
      <ReportHistoryItemV1Model>
        <CreatedOn>2026-07-11T06:00:02.3837575+02:00</CreatedOn>
        <FlowStatus>Draft</FlowStatus>
      </ReportHistoryItemV1Model>
    </History>
    <Id>1</Id>
    <Modified>2026-07-11T06:00:02</Modified>
    <Reference>MyReportRef2</Reference>
    <Type>CheckUp</Type>
    <Url>http://rental.chapps.com/api/Reports/2</Url>
  </ReportSummaryV1ModelResponse>
</ArrayOfReportSummaryV1ModelResponse>