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: Reading forms
engage:forms:readWrite: Managing forms
engage:offices:readOnly: Reading offices
engage:regions:readOnly: Reading region
engage:listings:readOnly: Reading listings
engage:offices:readWrite: Managing offices
engage:regions:readWrite: Managing regions
engage:settings:readOnly: Reading enterprise settings
engage:subjects:readOnly: Reading subjects
engage:webhooks:readOnly: Reading webhooks
engage:customers:readOnly: Reading customers
engage:employees:readOnly: Reading employees
engage:listings:readWrite: Managing listings
engage:settings:readWrite: Managing enterprise settings
engage:subjects:readWrite: Managing subjects
engage:templates:readOnly: Reading templates
engage:webhooks:readWrite: Managing webhooks
engage:customers:readWrite: Managing customers
engage:employees:readWrite: Managing employees
engage:expertises:readOnly: Reading expertises
engage:templates:readWrite: Managing templates
engage:expertises:readWrite: Managing expertises
engage:appointments:readOnly: Reading appointments
engage:availability:readOnly: Reading availability
engage:leadSegments:readOnly: Reading lead segments
engage:translations:readOnly: Reading translations
engage:appointments:readWrite: Managing appointments
engage:availability:readWrite: Managing availability
engage:leadSegments:readWrite: Managing lead segments
engage:translations:readWrite: Managing translations
engage:favoriteAgents:readOnly: Reading favorite agents
engage:favoriteAgents:readWrite: Managing favorite agents
engage:externalCalendars:readOnly: Reading external calendars
engage:externalCalendars:readWrite: Managing external calendars
|