Skip to main content
GET
List units

Authorizations

Authorization
string
header
required

Use Authorization: Bearer end_sk_* for partner API keys (e.g. end_sk_AbCd_example_api_key).

Query Parameters

limit
integer
default:50

Maximum number of records to return. Defaults to 50; maximum 100.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from the previous page.

Minimum string length: 1
external_id
string

Filter to units with this external identifier.

Minimum string length: 1
collection_id
string<uuid>

Filter to units in this collection.

status
enum<string>

Filter by issuance status, the unit's collection.token.status. pending also returns units that have no collection.

Available options:
pending,
active
chip
enum<string>

Filter to units with at least one paired chip (paired) or with none (unpaired).

Available options:
paired,
unpaired

Response

A page of units.

units
object[]
required
pagination
object
required