younifyd
Menu

Get User Entitlements Full

Get Full User Entitlements

GET/api/v2/users/{user_id}/entitlements/full

Use it in a workflow

  1. Add a step and choose the Zendesk connector.
  2. Pick the Get User Entitlements Full action (under Users).
  3. Fill in the fields below, then reference the result from later steps as {{getUserEntitlementsFull.response.data}}.

Request

Path parameters

user_idinteger (int64)required

The id of the user

Response

Returns 200 with an object. Read it in later steps with {{getUserEntitlementsFull.response.data.<field>}}.

entitlementsobject

Entitlements for Zendesk products (Live Chat, Explore, Voice, Knowledge)

chatobject2 fields
exploreobject2 fields
guideobject2 fields
talkobject2 fields
json
{
  "entitlements": {
    "chat": {
      "is_active": true,
      "name": "admin"
    },
    "explore": {
      "is_active": true,
      "name": "admin"
    },
    "guide": {
      "is_active": true,
      "name": "admin"
    },
    "talk": {
      "is_active": true,
      "name": "admin"
    }
  }
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.