API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve data

Retrieve the data. You may iterate through multiple calls until all records are retrieved.

The access token will expire automatically upon complete data retrieval. To retrieve data beyond the initial retrieval, set the keepAlive parameter to true. The default value is set to false, if not specified.

Header Parameters

Authorizationstring Required

Authorization token

Query Parameters

limitinteger

Specifies the maximum number of records to return.

offsetinteger

Specifies the starting point, based on a one-based index, for retrieving a batch of records.

keepAlivestring

Defaults to false. If set to true, the data will not be marked as retrieved after the last block is retrieved.

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
The request was successfully processed.

Response Attributes

Countinteger

Actual number of records returned in this response.

HasMoreboolean

True if there are additional records to retrieve, otherwise, false.

Limitinteger

Specifies the maximum number of records requested to be returned.

Offsetinteger

Indicates the 1-based index of the first record to return in the current batch of results.

TotalResultsinteger

Total number of records generated by the export.

UserProfilePreferencesarray

A collection of user profiles that matches the segment configuration and export parameters included in the request.

Show child attributes

400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
404
Object
The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found. See error description for more details.
500
Object
The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence.
503
Object
The server is unable to handle your request due to a temporary condition. You must delay your request for some time before trying again. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?