/api/v1/condition-reports

GET

const url = 'https://example.com/api/v1/condition-reports?kind=move_in&state=open&limit=50';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/condition-reports?kind=move_in&state=open&limit=50'

Parameters

Query Parameters

locationId

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

kind

string

Allowed values: move_in move_out

state

string

Allowed values: open finished

limit

integer

default: 50 >= 1 <= 200

cursor

string

<= 2048 characters

Responses

200

Default Response

application/json

object

items

required

Array<object>

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

locationId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

kind

required

string

Allowed values: move_in move_out

heldOn

required

string

notes

required

string | null

createdBy

required

object

displayName

required

string

createdAt

required

string

finishedAt

required

string | null

finishedBy

required

Any of:

object
null

object

displayName

required

string

roomCount

required

integer

>= -9007199254740991 <= 9007199254740991

photoCount

required

integer

>= -9007199254740991 <= 9007199254740991

rowVersion

required

integer

>= -9007199254740991 <= 9007199254740991

next_cursor

required

string | null

Example

{
  "items": [
    {
      "kind": "move_in"
    }
  ]
}