endstate.units.get

get(unitId: string, options?: RequestOptions): Promise<Unit>


Endpoint	`GET /v1/units/{unit_id}`
Credential	Secret key (`end_sk_...`), Session token (`end_sess_...`)
Retry class	`read`

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

Example

const result = await endstate.units.get(unit.id);

string

required

Unit id.

200 - Unit.

string

required

string | null

required

string | null

required

object | null

required

string

required

string | null

required

Tap redirect URL for this unit; takes precedence over product/collection/org defaults.

object | null

required

The unit’s collection. Null only for units created before collections existed.

object[]

required

Chips paired to this unit.

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
`session_token.invalid_or_expired`	401	Do not retry
`session_token.wrong_chip`	403	Do not retry
`unit.not_found`	404	Do not retry
`validation.failed`	400	Do not retry

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