/
5 minute read
August 24, 2021

Data Dictionary

Use this endpoint to retrieve the data dictionary of the DiVA API. The data dictionary contains records that specify the data fields available in the API, including the display name and description of each field.

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

Retrieve data dictionary (JSON)

Action: GET
Endpoint: /views/datadictionary

Retrieve the data dictionary. This endpoint returns a JSON object that contains an array of records matching your filter query.

Response body
Name Type Required? Description

field_name

string

Returned

Name of the field.

field_name_readable

string

Returned

Display name of the field in the Marqeta Dashboard.

field_name_description

string

Returned

Description of the field.

Sample response body

The following sample shows a representative response for a GET request to the /views/datadictionary?field_name=card_product_name,acting_card_type,ach_status endpoint.

JSON
Copied

Is this helpful?

Yes
No

Retrieve data dictionary (file export)

Action: GET
Endpoint: /views/datadictionary/{export_type}

Retrieve the data dictionary in the specified format. 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

The following sample shows a representative response for a GET request to the /views/datadictionary/xlsx?compress=zip endpoint.

JSON
Copied

Is this helpful?

Yes
No

Retrieve data dictionary schema

Action: GET
Endpoint: /views/datadictionary/schema

Retrieve a JSON representation of the data dictionary schema. 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/datadictionary/schema endpoint.

JSON
Copied

Is this helpful?

Yes
No
Join our developer newsletter