HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Retrieve a list of Privacy Profiles.

get
https://{tenanturl}/config/v1.0/privacy/profiles

Use this API to retrieve a list of privacy profiles.

Entitlements required (one of the following):

  • readPrivacyProfile (Read privacy profiles)
  • managePrivacyProfile (Manage privacy profiles)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Query Params
string
length ≀ 32

Fields to be used for sorting, comma separated, with a +/- operator. If nothing specified, then + is default.

string

Controls the results that are returned in a page.

A maximum of 50 results are returned if no pagination query parameters are specified.

Specify the following parameters:

count - Defines the total number of results that will be returned. The maximum value is 1000.

page - Identifies the requested page, or the offset.

limit - Defines the total number of results that are returned per page. The maximum value is 1000.

Note: The pagination parameter value must be HTML-encoded. Use the prefix "pagination=" in the query parameter.
Example: Paginate on count=10&page=1&limit=5

pagination=count%3D10%26page%3D1%26limit%3D5

string

Specify the search criteria for the results.

Suppported values are: id, name, /_embedded/relationships/extId, /_embedded/relationships/extCategory .

Supported operators are: contains, =. Use double quotation marks while searching for string values.

Note: The search parameter value must be HTML-encoded. Use the prefix "search=" in the query parameter.

Example: Search on name contains "myprofile"
search=name%20contains%20%22myprofile%22

Responses

Updated 11 months ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated 11 months ago