Skip to content

List Keycards​

GET
/keycards

List the keycards of the organization

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40

Query Parameters

filter

Filter criteria for vehicles. Allowed fields: 0, 1, 2, 3, 4, 5. Allowed operators: eq, ne, lt, gt, lte, gte, contains Use : for equality, <> for inequality, < and > for strict comparisons, <: and >: for inclusive comparisons, and ~ for substring matching. Use semicolons to AND conditions; multiple filter entries are OR alternatives.

Example"friendlyId~RFID;boundToLocationId:location_123"
sort*

Sort by up to 3 fields from: organizationId, friendlyId, boundToChargerId, boundToLocationId, boundToNamespaceId, groupname. Prefix with + for ascending or - for descending, and separate fields with commas.

Type
string
Required
Example"-organizationId"
Default
"-createdAt"
Min Length
1
Max Length
256
page

1-based page number; defaults to 1.

Type
integer
Example2
Default
1
Exclusive Minimum
0
Maximum
4294967295
per_page

Maximum records returned per page. Defaults to 10 and cannot exceed 100.

Type
integer
Example25
Default
10
Exclusive Minimum
0
Maximum
100

Responses​

success.keycard.list

application/json
Minimum0
Maximum9007199254740991

Playground​

Authorization
Headers
Variables
Key
Value

Samples​