Skip to main content
GET
List card account activities

Authorizations

x-api-key
string
header
required

Enter your API key

Query Parameters

page
integer
default:1

Which page of results to return, starting at 1 (the default). Use it with meta.totalPages to go through all results.

Required range: 1 <= x <= 9007199254740991
limit
integer
default:20

How many items to return per page. It must be between 1 and 100 (default 20).

Required range: 1 <= x <= 100
type
enum<string>[]

Only return certain kinds of activity: CHARGE, REPAYMENT, ADJUSTMENT, REBATE or INTEREST. Separate several with commas, for example CHARGE,REPAYMENT, or leave it out to get every type.

Available options:
CHARGE,
REPAYMENT,
ADJUSTMENT,
REBATE,
INTEREST
status
enum<string>[]

Only return card transactions in certain states, for example DECLINED to find declined card transactions. It applies only to card transactions, so other activity types are left out when you use it.

Available options:
PENDING,
CLEARED,
DECLINED,
VOIDED
cardId
string<uuid>[]

Only return activity on specific cards. Pass one or more card IDs from List cards, separated by commas.

userId
string[]

Only return activity on cards held by specific team members, using the userId values from List team members.

categoryId
string<uuid>[]

Only return card transactions in specific transaction categories, using the IDs from List transaction categories.

hasReceipt
boolean

Set to false to find activity that has no receipt, or true for activity that has one. Combine hasReceipt=false with type=CHARGE to find card transactions that still need a receipt.

chargeId
string

Look up one card transaction by its ID: the transaction ID (TID) shown in the dashboard. It must match exactly.

Required string length: 1 - 255
from
string<date>

Only return activity created on or after this date (YYYY-MM-DD, UTC). Use it with to to pull a month or a statement period.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
to
string<date>

Only return activity created on or before this date (YYYY-MM-DD, UTC). The whole day is included.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Response

items
object[]
required

The activities on this page, one object per activity.

meta
object
required

Pagination details, so you know how many results exist and which page you're on.