List cards beta

Returns a list of cards on an account, ordered in alphabetical order by card name.

SecurityCommonAuth
Request
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=C5462
personId
string <uuid> (personId) <= 36 characters

The ID of the person to work with.

Example: personId=775596ae-2624-40af-a9dc-9756110a4a04
limit
integer <int32> (limit) [ 1 .. 1000 ]
Default: 100

The maximum number of items to return.

offset
integer <int32> (offset)
Default: 0

The number of items to skip before returning the results.

state
Array of strings (state)

The state of the card. Use commas to pass multiple values. Has to be URL encoded.

Items Enum: "ACTIVE" "REPLACED" "TERMINATED" "SUSPENDED" "UNACTIVATED"
Example: state=ACTIVE%2CSUSPENDED
orderBy
string

The order in which to return results. By default, cards are sorted by name in ascending order.

Enum: "asc" "desc"
Example: orderBy=asc
startDate
string <date> (startDate)

The earliest date from which to retrieve records (includes records on this date).

Example: startDate=2021-02-15
endDate
string <date> (endDate)

The latest date until which to retrieve records (includes records on this date).

Example: endDate=2021-03-30
search
string (search)

The term to search the records for.

Example: search=Cesar+Treutel
budgetId
string <uuid> (budgetId) <= 36 characters

The ID of the budget to work with.

Example: budgetId=775596ae-2624-40af-a9dc-9756110a4a03
cardId
string <uuid> (cardId) <= 36 characters

The ID of the card to filter results by.

Example: cardId=e9293471-5eb3-4dbc-916c-dbaf9e2deefd
cardIds
Array of strings <uuid> (cardId)

The IDs of the cards to work with. Use commas to pass multiple values. Has to be URL encoded.

Example: cardIds=56%2C111
personIds
Array of strings <uuid> (personId)

The IDs of the people to work with. Use commas to pass multiple values. Has to be URL encoded.

Example: personIds=56%2C111
Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

get/cards
Request samples 
Response samples 
application/json
{
  • "limit": 100,
  • "offset": 0,
  • "count": 1,
  • "search": "string",
  • "rows": [
    ]
}