List reward accounts - Marqeta Docs

GET///

Retrieve a list of reward accounts.

URL query parameters

Fields	Description
credit_account_token string Optional	Unique identifier of the credit account for which you want to retrieve reward accounts. Allowable Values: Existing credit account token
is_active boolean Optional	A value of `true` returns active resources. A value of `false` returns inactive resources. Allowable Values: `true`, `false`
count integer Optional	Number of resources to retrieve. Allowable Values: 1–100
start_index integer Optional	Sort order index of the first resource in the returned array. Allowable Values: 0 min
sort_by_updated string Optional	Field on which to sort. Prefix the field name with a hyphen (`-`) to sort in descending order. Omit the hyphen to sort in ascending order. NOTE: You must sort using system field names, such as `updatedTime`. Do not sort by field names that appear in response bodies, such as `updated_time`. Allowable Values: `updatedTime`, `-updatedTime`

Response body

Fields	Description
count integer Returned	Number of resources returned. Allowable Values: 1–100
start_index integer Returned	Sort order index of the first resource in the returned array. Allowable Values: Any integer
end_index integer Returned	Sort order index of the last resource in the returned array. Allowable Values: Any integer
is_more boolean Returned	A value of `true` indicates that more unreturned resources exist. Allowable Values: `true`, `false`
data array of objects Returned	List of reward account objects. Allowable Values: Valid array of one or more reward account objects
data[].token string Returned	Unique identifier of the reward account. Allowable Values: 36 char max
data[].credit_account_token string Returned	Unique identifier of the associated credit account. Allowable Values: 36 char max
data[].bundle_token string Conditionally returned	Unique identifier of the associated bundle that contains the reward policy on which the reward account is based. Allowable Values: 36 char max
data[].is_active boolean Returned	A value of `true` indicates that the reward account is active. Allowable Values: `true`, `false`
data[].global_rules array of objects Conditionally returned	List of global rules. Allowable Values: Valid array of one or more global rules
data[].global_rules[].rule_token string Conditionally returned	Unique identifier of the rule. Allowable Values: 36 char max
data[].global_rules[].description string Conditionally returned	Description of the rule, pulled from the rule entry. Allowable Values: 255 char max
data[].created_time datetime Returned	Date and time when the reward account was created on the Marqeta platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ
data[].updated_time datetime Returned	Date and time when the reward account was last updated on the Marqeta platform, in UTC. Allowable Values: Format: yyyy-MM-ddThh:mm:ssZ

Sample response body

JSON

{
  "count": 1,
  "start_index": 0,
  "end_index": 0,
  "is_more": false,
  "data": [
    {
      "token": "4829608d-97e4-4a8c-bdab-20b26e7f243d",
      "credit_account_token": "bbf6c086-4286-4a1c-a3dd-2f54bf6fd799",
      "bundle_token": "f0cf97cb-76f7-47a5-83e7-188b9e741cf9",
      "is_active": true,
      "created_time": "2024-01-05T20:37:11Z",
      "updated_time": "2024-01-05T20:37:11Z"
    }
  ]
}