GuidesRecipesAPI Reference
API Reference
Select productLog inHelp centre

Query profiles

get
https://{region}-api.dotdigital.com/cpaas/profiles

See https://www.npmjs.com/package/mongo-querystring for query syntax. If you need to search for strings that are numeric, they can be wrapped in single quotes to prevent them being interpretted as numbers.

Query Params
string

The profile id to be retrieved

boolean

Retrieves the device details associated with the profile, such as browsers and mobile devices

boolean

Includes details of the App Messaging sessions that the profile has

string

Limits the fields returned by the query to one or more specific field names

boolean

Includes deleted profiles in the result

boolean

Includes system profiles in the result

integer

Limits the number of results returned

boolean

Returns the schema of a sample of profiles

integer

Starts results at a specific record index

Response

Updated 7 months ago

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

Updated 7 months ago