endstate.units.list

list(query?: ListParams & {
    externalId?: string;
    collectionId?: string;
    status?: "pending" | "active";
    chip?: "paired" | "unpaired";
}, options?: RequestOptions): Paginated<Unit, UnitsListResponse>


Endpoint	`GET /v1/units`
Credential	Secret key (`end_sk_...`)
Retry class	`read`

Retried on network failure, timeout, 429, and 5xx.

Example

const result = await endstate.units.list();

Parameters

integer

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

string

Opaque cursor from the previous page.

string

Filter to units with this external identifier.

string

Filter to units in this collection.

'pending' | 'active'

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

'paired' | 'unpaired'

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

Returns

200 - UnitsListResponse.

object[]

required

object

required

Errors

Branch on error.code, never on the HTTP status - several codes share one.

Code	HTTP	Retry
`auth.forbidden`	403	Do not retry
`auth.unauthorized`	401	Do not retry
`internal.error`	500	Safe to retry
`rate_limit.exceeded`	429	Safe to retry
`validation.failed`	400	Do not retry

See Errors and retries for the error types and how to narrow them.

Get started

Core SDK

Web SDK

Reader SDK

Example

Parameters

Returns

Errors

​Example

​Parameters

​Returns

​Errors

Example

Parameters

Returns

Errors