O auth2 (oauth2)
Retrieve an Access Token with the OAuth 2.0 flows described below before accessing the API. Once you have an access token, send it in the Authorization
HTTP header to authenticate with the API.
Flow type
clientCredentials
Token URL
https://auth.development.pexipengage.com/realms/{enterprise}/protocol/openid-connect/token
Scopes
engage:forms:readOnly
:
engage:forms:readWrite
:
engage:offices:readOnly
:
engage:regions:readOnly
:
engage:listings:readOnly
:
engage:offices:readWrite
:
engage:regions:readWrite
:
engage:settings:readOnly
: Reading enterprise settings
engage:subjects:readOnly
:
engage:webhooks:readOnly
:
engage:customers:readOnly
:
engage:employees:readOnly
:
engage:listings:readWrite
:
engage:settings:readWrite
: Managing enterprise settings
engage:subjects:readWrite
:
engage:templates:readOnly
:
engage:webhooks:readWrite
:
engage:customers:readWrite
:
engage:employees:readWrite
:
engage:expertises:readOnly
:
engage:templates:readWrite
:
engage:expertises:readWrite
:
engage:appointments:readOnly
:
engage:availability:readOnly
:
engage:leadSegments:readOnly
:
engage:translations:readOnly
:
engage:appointments:readWrite
:
engage:availability:readWrite
:
engage:leadSegments:readWrite
:
engage:translations:readWrite
:
engage:favoriteAgents:readOnly
:
engage:favoriteAgents:readWrite
:
engage:callbackRequests:readOnly
: Reading callback requests
engage:callbackRequests:readWrite
: Managing callback requests
engage:externalCalendars:readOnly
: Reading external calendars
engage:externalCalendars:readWrite
: Managing external calendars