Skip to content
Docs
Select language:English

/api/v1/incidents

GET
/api/v1/incidents
curl --request GET \
  --url 'https://example.com/api/v1/incidents?kind=burglary&limit=20'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “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: burglary fire flood loss other
limit
integer
default: 20 >= 1 <= 200
cursor
string
<= 2048 characters

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
items
required
Array<object>
object
id
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
occurredOn
required
string
policeReference
required
string | null
insurerReference
required
string | null
thingCount
required
integer
>= -9007199254740991 <= 9007199254740991
claimCount
required
integer
>= -9007199254740991 <= 9007199254740991
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
next_cursor
required
string | null
Examplegenerated
{
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "kind": "example",
      "occurredOn": "example",
      "policeReference": "example",
      "insurerReference": "example",
      "thingCount": 1,
      "claimCount": 1,
      "rowVersion": 1
    }
  ],
  "next_cursor": "example"
}