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

The ID of the account to work with.

Example: accountId=F50091
string or Array of strings

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

Enum: "ACTIVE" "REPLACED" "TERMINATED" "SUSPENDED" "UNACTIVATED"
Example: state=ACTIVE,REPLACED
orderBy
string

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

Enum: "asc" "desc"
startDate
string

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

Example: startDate=2020-01-01
endDate
string

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

Example: endDate=2020-01-01
search
string <= 100 characters

The term to search the records for.

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

The ID of the budget to work with.

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

The ID of the card to work with.

Example: cardId=e9293471-5eb3-4dbc-916c-dbaf9e2deefd
string or Array of strings

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

cardOwnerType
string

The card owner type of the card.

Enum: "PEOPLE" "BUDGET"
Example: cardOwnerType=PEOPLE
personId
string <uuid> <= 36 characters

The ID of the person to work with.

Example: personId=775596ae-2624-40af-a9dc-9756110a4a04
string or Array of strings

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

limit
integer [ 1 .. 1000 ]
Default: 100

The maximum number of results to return.

Example: limit=200
offset
integer
Default: 0

The number of items to skip before returning results.

Example: offset=100
Responses
200

OK

get/cards
Request samples 
Response samples 
application/json
{
  • "limit": 200,
  • "offset": 100,
  • "count": 67,
  • "search": "Cesar+Treutel",
  • "rows": [
    ]
}