API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve consent types

This method allows you to retrieve a specific consent or all consent types. Use the optional query parameter locale to only retrieve the collection of localized fields for a specific locale across all consent types. If none of the consents have a localized field collection for the specified locale, the HTTP status code of 404-Not Found is returned.

Header Parameters

Authorizationstring Required

Authorization token

Content-Typestring

Media type indicating that the content is in JSON format.

Query Parameters

Idstring

Type Id. If specified, only the Type with this Id will be returned. Default value is 0.

localestring

A valid locale associated with the ConsentType. Ex: “en”, “en-us”, “en-uk”, “fr-ca”.

latestVersionOnlystring

Option to limit the number of returned consent versions. True will return only the most recent version. False will return all versions of a consent. Default value is False.

Path Parameters

clientIdstring Required

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

Response

200
Object
The request was successfully processed.

Response Attributes

ConsentTypesarray

Array of consent types used in GET requests.

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.
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?