Get Device Claim
GET/v1/org/:org_id/device_claims/:claim_id
Return a device claim visible to your organization - either the
source (manufacturer) or the assigned destination (customer).
Customers use it to check a claim's status and device count before
claiming the devices.
Unlike other lookups, a claim
belonging to neither role on your organization returns 404 rather
than 403, so its existence is not confirmed to an uninvolved org.
Required Scope: read-devices
Includes device_count, the number of devices currently linked to
the claim - only populated on this single-claim GET.
claim_id is interpreted according to id_type: by default (or with
id_type=claim_id) it is the literal claim ID; with
id_type=claim_token it is instead a claim_token (see
set_claim_token on Create Device Claim/Update Device
Claim), base64url-encoded (unpadded, RFC 4648 §5) so it survives as
a single path segment. A recognized-but-unmatched token and an
unmatched literal ID both return 404, with distinct messages so you
can tell which lookup ran; a claim_token segment that fails to
decode or does not validate as a known token format returns 400,
as does any id_type value other than claim_id/claim_token.
Either way the response is the same claim, including its real
claim_id - claiming the devices (Claim Devices) always requires
that literal ID, never the token.
The claim_token lookup is intentionally more permissive than the
source-or-assigned-destination visibility rule above: an unassigned
claim (no destination_org_id) is resolvable by token from any
organization, mirroring Claim Devices' own rule that any org may
claim an unassigned claim. This is what makes the token
useful as a handoff mechanism (e.g. printed as a barcode on the
carton) - once the claim is assigned to a destination, its token folds
into the same 404 as everyone else not involved with the claim.
Request
Responses
- 200
- 400
- 404
- 500
Device Claim
Bad Request
Not Found
Internal Server Error