API explorerChangelog
Overview

Sections

Theme switcher

Commit

Query Parameters

keepFilesboolean

This parameter determines how exported data is managed. If set to true, the system retains the export files used by the API to retrieve data while marking the token as retrieved. By default, this is set to false, ensuring the system automatically deletes these files after retrieval.

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.

accessTokeninteger Required

Secure token returned by the Initiate call, required as a URL parameter in all subsequent API requests.

Response

200
Object

OK - The request was successfully received.

400
Object

Bad Request

Response Attributes

Messagestring | null
401
Object

Unauthorized

Response Attributes

Messagestring | null
403
Object

Forbidden

Response Attributes

Messagestring | null
404
Object

Not Found

Response Attributes

Messagestring | null
503
Object

Server Error

Response Attributes

Messagestring | null
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?