Authentication

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:appointments:readOnly:

    Reading appointments

  • engage:appointments:readWrite:

    Managing appointments

  • engage:availability:readOnly:

    Reading availability

  • engage:availability:readWrite:

    Managing availability

  • engage:callbackRequests:readOnly:

    Reading callback requests

  • engage:callbackRequests:readWrite:

    Managing callback requests

  • engage:customers:readOnly:

    Reading customers

  • engage:customers:readWrite:

    Managing customers

  • engage:dataExports:readOnly:

    Reading data exports

  • engage:dataExports:readWrite:

    Managing data exports

  • engage:employees:readOnly:

    Reading employees

  • engage:employees:readWrite:

    Managing employees

  • engage:expertises:readOnly:

    Reading expertises

  • engage:expertises:readWrite:

    Managing expertises

  • engage:externalCalendars:readOnly:

    Reading external calendars

  • engage:externalCalendars:readWrite:

    Managing external calendars

  • engage:favoriteAgents:readOnly:

    Reading favorite agents

  • engage:favoriteAgents:readWrite:

    Managing favorite agents

  • engage:forms:readOnly:

    Reading forms

  • engage:forms:readWrite:

    Managing forms

  • engage:leadSegments:readOnly:

    Reading lead segments

  • engage:leadSegments:readWrite:

    Managing lead segments

  • engage:listings:readOnly:

    Reading listings

  • engage:listings:readWrite:

    Managing listings

  • engage:offices:readOnly:

    Reading offices

  • engage:offices:readWrite:

    Managing offices

  • engage:regions:readOnly:

    Reading region

  • engage:regions:readWrite:

    Managing regions

  • engage:settings:readOnly:

    Reading enterprise settings

  • engage:settings:readWrite:

    Managing enterprise settings

  • engage:subjects:readOnly:

    Reading subjects

  • engage:subjects:readWrite:

    Managing subjects

  • engage:templates:readOnly:

    Reading templates

  • engage:templates:readWrite:

    Managing templates

  • engage:translations:readOnly:

    Reading translations

  • engage:translations:readWrite:

    Managing translations

  • engage:webhooks:readOnly:

    Reading webhooks

  • engage:webhooks:readWrite:

    Managing webhooks