API explorerChangelog
Overview

Sections

Theme switcher

Commit

This endpoint should only be accessed if the keepAlive parameter was set to true when retrieving the data. Invoking this endpoint marks the data retrieval as “Complete” and expires the access token.

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
Nullable:
True
401
Object
Unauthorized

Response Attributes

Messagestring
Nullable:
True
403
Object
Forbidden

Response Attributes

Messagestring
Nullable:
True
404
Object
Not Found

Response Attributes

Messagestring
Nullable:
True
503
Object
Server Error

Response Attributes

Messagestring
Nullable:
True
Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?