/api/v1/things/{id}/box-checks

GET

/api/v1/things/{id}/box-checks

curl --request GET \
  --url 'https://example.com/api/v1/things/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/box-checks?limit=20'

Parameters

Path Parameters

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)$/

Query Parameters

limit

integer

default: 20 >= 1 <= 200

cursor

string

<= 2048 characters

Responses

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)$/

at

required

string

by

required

object

displayName

required

string

seen

required

number

notHere

required

number

split

required

number

movedIn

required

number

next_cursor

required

string | null

Example^generated

{
  "items": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "at": "example",
      "by": {
        "displayName": "example"
      },
      "seen": 1,
      "notHere": 1,
      "split": 1,
      "movedIn": 1
    }
  ],
  "next_cursor": "example"
}