Appearance

Get Roles ​

Endpoint ​

http
GET /unified/user-directory/roles/{id}
Integrations supported
  • Adobe Marketo Engage
  • Datadog
  • Freshdesk
  • Jira
  • Salesforce
  • Zoho CRM
  • Zoom

Path parameters ​

id
string
REQUIRED · The ID of the resource.
Example: 23423523

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d

Response Body ​

id
string
REQUIRED · The unique identifier for a role
Supported in
  • Adobe Marketo Engage
  • Datadog
  • Freshdesk
  • Jira
  • Salesforce
  • Zoho CRM
  • Zoom
name
string
The name of the role
Supported in
  • Adobe Marketo Engage
  • Datadog
  • Freshdesk
  • Jira
  • Salesforce
  • Zoho CRM
  • Zoom
label
string
The display label of the role
description
string
The description of the role
created_at
string
The date and time the role was created
Supported in
  • Datadog
  • Freshdesk
updated_at
string
The date and time the role was last updated
Supported in
  • Datadog
  • Freshdesk
remote_data
object
Raw data returned from the remote API call.