GET/v1/devices

List keypad devices

Returns the environment's keypad devices, one page at a time, retired ones only when asked, or only those assigned to customerExternalId. Needs customers:read.

curl 'https://api.entitler.co/v1/devices' \
  -H "Authorization: Bearer $ENTITLER_KEY"

Credentials

Send any one of these:

Bearer token

Query parameters

Name	Type	Description
`target.team_id`	string
`target.project_id`	string
`target.environment_id`	string
`include_retired`	boolean
`page_size`	integer (int64)
`page_token`	string
`customer_external_id`	string

Responses

`200`The ListDevicesResponse message.

ListDevicesResponse

devicesarray of KeypadDevicerequired
- assignedAtinteger
  at least 0; at most 18446744073709552000
- customerExternalIdstring
- digitsKeypadDigitsrequired
  One of KEYPAD_DIGITS_UNSPECIFIED, KEYPAD_DIGITS_FULL, KEYPAD_DIGITS_RESTRICTED.
- externalIdstringrequired
- idstringrequired
- productIdstring
- registeredAtintegerrequired
  at least 0; at most 18446744073709552000
- retiredAtinteger
  at least 0; at most 18446744073709552000
nextPageTokenstring

`Error`A refusal, with the HTTP status of its gRPC code.

Error

errorobjectrequired
- codestringrequired
- parametersobjectrequired
  Each value: string
- reasonstringor nullrequired