5 minute read
Users
Use this view endpoint to retrieve user data aggregated by user. The data is derived from user 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 user data (JSON)
Copy section link
Action: GET
Endpoint: /views/users/detail
Retrieve user data aggregated by user. This endpoint returns a JSON object that contains an array of records matching your filter query.
Sample response body
Copy section link
The following sample shows a representative response for a GET request to the /views/users/detail?program=my_program endpoint.
Is this helpful?
Retrieve user data (file export)
Copy section link
Action: GET
Endpoint: /views/users/detail/{export_type}
Retrieve user data aggregated by user. 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
Copy section link
| Fields | Description |
|---|---|
export_type string required |
File format in which to export the data. Allowable Values: csv |
Query parameters
Copy section link
| Fields | Description |
|---|---|
compress string optional |
Type of file compression for the exported file. Allowable Values: gz, zip Default value: gz |
Sample response body
Copy section link
Is this helpful?
Retrieve user schema
Copy section link
Action: GET
Endpoint: /views/users/detail/schema
Retrieve a JSON representation of the users view schema for data aggregated by user. The schema object contains an array of objects that describe the available columns and the data type of each column.
Sample response body
Copy section link
The following sample shows a representative response for a GET request to the /views/users/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).
Is this helpful?