Get Cards

get

https://public-api.spendesk.com/v1/cards

Allowed Scopes: experimental:card:read

Returns cards for the authenticated company. Lost, stolen, damaged, expired and cancelled cards are not listed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

Page number

pageSize

integer

1 to 30

Defaults to 30

Page size

type

string

enum

Filter by card type.

Allowed:

status

string

Filter by card status label, case-sensitive: Active, Blocked, New, Ready, Pre-activated, Hidden, Unknown or Aborted. The legacy raw code (for example ACT or BLO) also matches. Lost, stolen, damaged, expired and cancelled cards are never listed, so filtering on those statuses returns no cards.

userId

string

Filter by card owner user ID.

createdAfter

date

^\d{4}-\d{2}-\d{2}$

Return cards created on or after this date (YYYY-MM-DD, UTC).

createdBefore

date

^\d{4}-\d{2}-\d{2}$

Return cards created on or before this date (YYYY-MM-DD, UTC).

Headers

X-Company-Id

string

ID of the company the request acts on. Required with an organisation-level token; not needed with a company-level token.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Default Response

400Bad request

401Unauthorized

403Forbidden

404Not Found

429Too Many Requests

500Internal Server Error

503Service Unavailable