/
5 minute read
February 22, 2021

Cards

Hidden

Use this view endpoint to retrieve card state and history data aggregated by card. The data is derived from card information in the Marqeta platform.

This endpoint supports multiple response formats, query filtering, field filtering, sorting, and pagination. For more information about response options, see Response Customization.

Retrieve card data (JSON)

Action: GET
Endpoint: /views/cards/detail

Retrieve card state and history data aggregated by card. This endpoint returns a JSON object that contains an array of records matching your filter query.

Sample response body

The following sample shows a representative response for a GET request to the /views/cards/detail?program=my_program&fields=card_created_date,card_activation_date,card_state,card_type&card_created_date=2017-09-01..2017-09-30 endpoint.

Copied

Is this helpful?

Yes
No

Retrieve card data (file export)

Action: GET
Endpoint: /views/cards/detail/{export_type}

Retrieve card state and history data aggregated by card. This endpoint asynchronously generates a file in the specified format and returns a job token for retrieving the file when it is completed. The file contains a list of records matching your filter query.

URL path parameters
Fields Description

export_type

string
Required

File format in which to export the data.

Allowable Values:

csv

Query parameters
Fields Description

compress

string
Optional

Type of file compression for the exported file.

Allowable Values:

gz, zip

Default value:
gz

Sample response body
Copied

Is this helpful?

Yes
No

Retrieve card schema

Action: GET
Endpoint: /views/cards/detail/schema

Retrieve a JSON representation of the card view schema for data aggregated by card. The schema object contains an array of objects that describe the available columns and the data type of each column.

Sample response body

The following sample shows a representative response for a GET request to the /views/cards/detail/schema?program=my_program endpoint. The schema can vary based on the data aggregation level and the data you are authorized to access (based on the credentials you provide in your request).

Copied

Is this helpful?

Yes
No

Feedback on this page?

If you feel we can do anything better, please let our team know.