Skip to content
Docs
Select language:English

/api/v1/paperwork

GET
/api/v1/paperwork
curl --request GET \
  --url 'https://example.com/api/v1/paperwork?limit=20&role=photo&subjectType=thing&expiry=any'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 20 >= 1 <= 200
cursor
string
<= 2048 characters
q
string
<= 200 characters
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)$/
role
string
Allowed values: photo receipt invoice manual warranty_doc proof condition_out condition_in registration document
subjectType
string
Allowed values: thing place location
expiry
string
Allowed values: any expiring expired

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
items
required
Array<object>
object
attachment
required
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)$/
role
required
string
sort
required
number
file
required
Any of:
object
key
additional properties
url
required
string | null
subject
required
object
key
additional properties
createdBy
required
object
displayName
required
string
rowVersion
required
number
subject
required
object
type
required
string
Allowed values: thing place location
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)$/
name
required
string
path
required
string
shortCode
string | null
expiring
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)$/
kind
required
string
Allowed values: registration insurance licence inspection lease contract other
expiresOn
required
string
state
required
string
Allowed values: ok expiring expired
snippet
string
next_cursor
required
string | null
Example
{
  "items": [
    {
      "subject": {
        "type": "thing"
      },
      "expiring": {
        "kind": "registration",
        "state": "ok"
      }
    }
  ]
}