HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Create a CSV Download Request

This endpoint will generate a CSV report based on the provided parameters.

The globalSearch and search parameters reuse the search functionality for the list endpoints of the entityType specified:

The columns in the report will vary based on entityType. By default (if the columns parameter is not provided), all available fields will be included. The names of these columns can then be passed in the columns parameter for future reports to only include those fields.

If downloadMethod is set to IN_BROWSER, use information in the response to make a request to the Get the DownloadRequest endpoint to retrieve the file.

This endpoint supports Sandbox Mode.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
columns
array of strings
columns
string
enum
Allowed:
string
enum
required
string
string
Headers
string
required
Defaults to 2024-02-21

The Arcadia-Version for the request

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/csv