Appearance

List Users ​

Endpoint ​

http
GET /unified/user-directory/users
Integrations supported
  • Accelo
  • ActiveCampaign
  • Adobe
  • Adobe Marketo Engage
  • Adobe Sign
  • Aircall
  • Asana
  • Atlassian
  • Avoma
  • Azure Active Directory
  • BambooHR
  • Basecamp
  • Box
  • BrowserStack
  • Calendly
  • Capsule
  • ClickUp
  • Close
  • Cloudflare
  • Confluence
  • Constant Contact
  • Copper
  • Datadog
  • Dialpad
  • DocuSign
  • Dropbox
  • Fireflies.ai
  • FreeAgent
  • Freshdesk
  • GitHub
  • GitLab
  • Google Analytics
  • Google Workspace
  • Gorgias
  • Grafana
  • Help Scout
  • HubSpot
  • Humaans
  • Insightly
  • Intercom
  • Jenkins
  • Jetbrains
  • Jira
  • Keap
  • Lever
  • Linear
  • Lucid
  • Miro
  • Monday.com
  • Moneybird
  • Notion
  • Okta
  • Outreach
  • PagerDuty
  • PandaDoc
  • Pipedrive
  • Salesflare
  • Salesforce
  • SendGrid
  • Sentry
  • Shortcut
  • Slack
  • Smartsheet
  • Snowflake
  • Tableau
  • Tailscale
  • TalentLyft
  • Teamleader
  • Teamwork CRM
  • Twingate
  • Wingman
  • Xero
  • YouTrack
  • Youtrack Hub
  • Zendesk
  • Zendesk Sell
  • Zoho Analytics
  • Zoho CRM
  • Zoom
  • Zscaler
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Adobe Marketo Engage
  • Asana
  • Calendly
  • Confluence
  • Datadog
  • Dropbox
  • Freshdesk
  • GitHub
  • HubSpot
  • Jira
  • Okta
  • Outreach
  • PagerDuty
  • Salesforce

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
organization_id
string
Integration specific notes
  • AsanaThe ID of the organization to filter by
  • GitHubThe unique identifier of an organization
Required in
  • GitHub
Supported in
  • Asana
email
string
The email of the user
Supported in
  • Box
  • DocuSign
  • Gorgias
  • Zendesk Sell
roles
array
The roles of the user
Supported in
  • Gorgias
  • Zendesk Sell
name
string
The name of the user
Supported in
  • Box
  • Zendesk Sell
created_at
string
The date and time the user was created
Supported in
  • Xero
updated_at
string
The date and time the user was last updated
Supported in
  • Xero
first_name
string
The first name of the user
Supported in
  • Xero
last_name
string
The last name of the user
Supported in
  • Xero
status
string
The status of the user. If no clear mapping is available, then the raw value is returned.
All possible enum values:
  • active
  • deleted
  • inactive
  • invited
Supported in
  • Zendesk Sell
  • Zoho CRM
include_last_login_at
boolean
Whether to include the last login date and time for each user. Requires Premium P1 or P2 license.
Supported in
  • Azure Active Directory

Response Body ​

result
object[]
List of Users
id
string
REQUIRED · The unique identifier for a user
Supported in
  • Accelo
  • ActiveCampaign
  • Adobe
  • Adobe Marketo Engage
  • Adobe Sign
  • Aircall
  • Asana
  • Atlassian
  • Avoma
  • Azure Active Directory
  • BambooHR
  • Basecamp
  • Box
  • BrowserStack
  • Calendly
  • Capsule
  • ClickUp
  • Close
  • Cloudflare
  • Confluence
  • Constant Contact
  • Copper
  • Datadog
  • Dialpad
  • DocuSign
  • Dropbox
  • Fireflies.ai
  • FreeAgent
  • Freshdesk
  • GitHub
  • GitLab
  • Google Analytics
  • Google Workspace
  • Gorgias
  • Grafana
  • Help Scout
  • HubSpot
  • Humaans
  • Insightly
  • Intercom
  • Jenkins
  • Jetbrains
  • Jira
  • Keap
  • Lever
  • Linear
  • Lucid
  • Miro
  • Monday.com
  • Moneybird
  • Notion
  • Okta
  • Outreach
  • PagerDuty
  • PandaDoc
  • Pipedrive
  • Salesflare
  • Salesforce
  • SendGrid
  • Sentry
  • Shortcut
  • Slack
  • Smartsheet
  • Snowflake
  • Tableau
  • Tailscale
  • TalentLyft
  • Teamleader
  • Teamwork CRM
  • Twingate
  • Wingman
  • Xero
  • YouTrack
  • Youtrack Hub
  • Zendesk
  • Zendesk Sell
  • Zoho Analytics
  • Zoho CRM
  • Zoom
  • Zscaler
first_name
string
The first name of the user
Supported in
  • Accelo
  • ActiveCampaign
  • Adobe
  • Adobe Marketo Engage
  • Adobe Sign
  • Asana
  • Avoma
  • Azure Active Directory
  • BambooHR
  • Capsule
  • Close
  • Cloudflare
  • Dialpad
  • DocuSign
  • Dropbox
  • FreeAgent
  • Google Workspace
  • Gorgias
  • Help Scout
  • Humaans
  • Insightly
  • Keap
  • Linear
  • Okta
  • Outreach
  • PandaDoc
  • Salesflare
  • Salesforce
  • SendGrid
  • Slack
  • Smartsheet
  • Snowflake
  • Teamleader
  • Teamwork CRM
  • Twingate
  • Xero
  • Zoho CRM
  • Zoom
last_name
string
The last name of the user
Supported in
  • Accelo
  • ActiveCampaign
  • Adobe
  • Adobe Marketo Engage
  • Adobe Sign
  • Asana
  • Avoma
  • Azure Active Directory
  • BambooHR
  • Capsule
  • Close
  • Cloudflare
  • Dialpad
  • DocuSign
  • Dropbox
  • FreeAgent
  • Google Workspace
  • Gorgias
  • Help Scout
  • Humaans
  • Insightly
  • Keap
  • Linear
  • Okta
  • Outreach
  • PandaDoc
  • Salesflare
  • Salesforce
  • SendGrid
  • Slack
  • Smartsheet
  • Snowflake
  • Teamleader
  • Teamwork CRM
  • Twingate
  • Xero
  • Zoho CRM
  • Zoom
name
string
The name of the user
Supported in
  • Accelo
  • ActiveCampaign
  • Adobe
  • Aircall
  • Asana
  • Atlassian
  • Avoma
  • Azure Active Directory
  • Basecamp
  • Box
  • BrowserStack
  • Calendly
  • Capsule
  • Close
  • Cloudflare
  • Confluence
  • Copper
  • Datadog
  • Dialpad
  • DocuSign
  • Dropbox
  • Fireflies.ai
  • FreeAgent
  • Freshdesk
  • GitLab
  • Google Workspace
  • Gorgias
  • Grafana
  • Help Scout
  • Humaans
  • Intercom
  • Jenkins
  • Jetbrains
  • Jira
  • Lever
  • Linear
  • Lucid
  • Miro
  • Monday.com
  • Moneybird
  • Notion
  • Okta
  • Outreach
  • PagerDuty
  • PandaDoc
  • Pipedrive
  • Salesflare
  • Salesforce
  • SendGrid
  • Sentry
  • Shortcut
  • Slack
  • Smartsheet
  • Snowflake
  • Tableau
  • TalentLyft
  • Twingate
  • Wingman
  • Xero
  • YouTrack
  • Youtrack Hub
  • Zendesk
  • Zendesk Sell
  • Zoho Analytics
  • Zoho CRM
  • Zoom
  • Zscaler
username
string
The username of the user
Supported in
  • Accelo
  • ActiveCampaign
  • Adobe
  • Adobe Sign
  • BrowserStack
  • Calendly
  • Capsule
  • ClickUp
  • Confluence
  • Datadog
  • DocuSign
  • GitHub
  • GitLab
  • Lever
  • Lucid
  • Okta
  • Outreach
  • Salesforce
  • SendGrid
  • Sentry
  • Slack
  • Snowflake
  • TalentLyft
  • YouTrack
  • Youtrack Hub
emails
object[]
The emails of the user
Supported in
  • Accelo
  • ActiveCampaign
  • Adobe
  • Adobe Marketo Engage
  • Adobe Sign
  • Aircall
  • Asana
  • Atlassian
  • Avoma
  • Azure Active Directory
  • BambooHR
  • Basecamp
  • Box
  • BrowserStack
  • Calendly
  • Capsule
  • ClickUp
  • Close
  • Cloudflare
  • Confluence
  • Constant Contact
  • Copper
  • Datadog
  • Dialpad
  • DocuSign
  • Dropbox
  • Fireflies.ai
  • FreeAgent
  • Freshdesk
  • Google Analytics
  • Google Workspace
  • Gorgias
  • Grafana
  • Help Scout
  • HubSpot
  • Humaans
  • Insightly
  • Intercom
  • Jenkins
  • Jetbrains
  • Jira
  • Keap
  • Lever
  • Linear
  • Lucid
  • Miro
  • Monday.com
  • Moneybird
  • Notion
  • Okta
  • Outreach
  • PagerDuty
  • PandaDoc
  • Pipedrive
  • Salesflare
  • Salesforce
  • SendGrid
  • Sentry
  • Shortcut
  • Slack
  • Smartsheet
  • Snowflake
  • Tableau
  • Tailscale
  • TalentLyft
  • Teamleader
  • Teamwork CRM
  • Twingate
  • Wingman
  • Xero
  • YouTrack
  • Youtrack Hub
  • Zendesk
  • Zendesk Sell
  • Zoho Analytics
  • Zoho CRM
  • Zoom
  • Zscaler
email
string
The email address
type
string
The type of email address
is_primary
boolean
Whether the email address is primary
phones
object[]
The phones of the user
Supported in
  • Accelo
  • ActiveCampaign
  • Azure Active Directory
  • Box
  • Confluence
  • Dialpad
  • Freshdesk
  • Google Workspace
  • Humaans
  • Keap
  • Monday.com
  • Okta
  • Outreach
  • Pipedrive
  • Salesflare
  • Salesforce
  • SendGrid
  • Slack
  • Teamleader
  • Teamwork CRM
  • Zendesk
  • Zendesk Sell
  • Zoho CRM
  • Zoom
number
string
The phone number
type
string
The type of phone number
status
string
The status of the user. If no clear mapping is available, then the raw value is returned.
All possible enum values:
  • active
  • inactive
  • deleted
  • invited
Supported in
  • Accelo
  • ActiveCampaign
  • Adobe
  • Aircall
  • Atlassian
  • Avoma
  • Azure Active Directory
  • BambooHR
  • Box
  • Capsule
  • Cloudflare
  • Datadog
  • Dialpad
  • DocuSign
  • Dropbox
  • Freshdesk
  • GitLab
  • Google Workspace
  • Gorgias
  • Grafana
  • Humaans
  • Insightly
  • Jetbrains
  • Jira
  • Keap
  • Linear
  • Miro
  • Monday.com
  • Okta
  • Outreach
  • PandaDoc
  • Pipedrive
  • Salesforce
  • Sentry
  • Slack
  • Smartsheet
  • Snowflake
  • Tableau
  • Teamleader
  • Teamwork CRM
  • Twingate
  • Youtrack Hub
  • Zendesk
  • Zendesk Sell
  • Zoho Analytics
  • Zoho CRM
  • Zoom
is_email_verified
boolean
Whether the user's email has been verified
Supported in
  • Close
  • Datadog
  • Dropbox
  • Monday.com
  • PandaDoc
  • Sentry
  • Slack
is_2fa_enabled
boolean
Whether the user has 2FA enabled
Supported in
  • ActiveCampaign
  • Cloudflare
  • Google Workspace
  • Gorgias
  • Sentry
  • Shortcut
  • Youtrack Hub
  • Zendesk
roles
object[]
The roles of the user
Supported in
  • Accelo
  • Avoma
  • Azure Active Directory
  • BrowserStack
  • Calendly
  • ClickUp
  • Cloudflare
  • Confluence
  • Datadog
  • Dialpad
  • DocuSign
  • Dropbox
  • Fireflies.ai
  • FreeAgent
  • Freshdesk
  • Gorgias
  • Grafana
  • Help Scout
  • HubSpot
  • Humaans
  • Insightly
  • Intercom
  • Lever
  • Linear
  • Lucid
  • Miro
  • Monday.com
  • Notion
  • Outreach
  • PagerDuty
  • PandaDoc
  • Salesflare
  • Salesforce
  • SendGrid
  • Sentry
  • Shortcut
  • Smartsheet
  • Snowflake
  • Tableau
  • TalentLyft
  • Twingate
  • Wingman
  • Xero
  • Youtrack Hub
  • Zendesk
  • Zendesk Sell
  • Zoho Analytics
  • Zoho CRM
  • Zoom
  • Zscaler
id
string
The unique identifier for a role
name
string
The name of the role
group
string
The role of the user in the group. This is available when the user can have different roles in different groups or teams in an application.
organization
string
The role of the user in the organization. This is available when the user can have different roles in different organizations in an application.
organizations
object[]
The organizations of the user
Supported in
  • Asana
  • Dialpad
  • Jetbrains
  • Lucid
  • Monday.com
id
string
The unique identifier for an organization
name
string
The name of the organization
licenses
object[]
The licenses of the user or the products the user has access to
Supported in
  • Adobe
  • Atlassian
  • BrowserStack
  • Calendly
  • Dialpad
  • Freshdesk
  • Jetbrains
  • Monday.com
  • Outreach
  • PandaDoc
  • Zendesk
  • Zoom
id
string
The unique identifier for a license
name
string
The name of the license
organization
string
The unique identifier of the organization to which the license belongs
last_active_at
string
The date and time the user was last active for the license
groups
object[]
The groups of the user
id
string
The unique identifier for a group
name
string
The name of the group
organization
string
The unique identifier of the organization to which the group belongs
avatar
string
The avatar of the user
Supported in
  • Asana
  • Atlassian
  • Avoma
  • Basecamp
  • Box
  • Calendly
  • Capsule
  • ClickUp
  • Close
  • Datadog
  • Dialpad
  • GitHub
  • GitLab
  • Google Workspace
  • Grafana
  • Humaans
  • Jira
  • Lever
  • Linear
  • Monday.com
  • Notion
  • PagerDuty
  • Pipedrive
  • Salesflare
  • Salesforce
  • Sentry
  • Shortcut
  • Slack
  • Teamleader
  • Twingate
  • YouTrack
  • Youtrack Hub
  • Zendesk
  • Zoom
timezone
string
The timezone of the user
Supported in
  • Accelo
  • ActiveCampaign
  • Aircall
  • Basecamp
  • Box
  • Calendly
  • Capsule
  • Close
  • Confluence
  • Dialpad
  • DocuSign
  • Freshdesk
  • Gorgias
  • Help Scout
  • Humaans
  • Insightly
  • Jira
  • Keap
  • Linear
  • Monday.com
  • Moneybird
  • Okta
  • Outreach
  • PagerDuty
  • Pipedrive
  • Salesforce
  • Slack
  • Teamleader
  • Zendesk
  • Zendesk Sell
  • Zoho CRM
  • Zoom
languages
string[]
The languages preferred by the user
Supported in
  • ActiveCampaign
  • Aircall
  • Azure Active Directory
  • Box
  • Dialpad
  • Freshdesk
  • Google Workspace
  • Gorgias
  • Humaans
  • Monday.com
  • Moneybird
  • Okta
  • Outreach
  • Salesforce
  • Teamleader
  • Youtrack Hub
  • Zoho CRM
  • Zoom
bio
string
The bio of the user
Supported in
  • Basecamp
  • Datadog
  • Gorgias
  • Humaans
  • Salesforce
  • Slack
created_at
string
The date and time the user was created
Supported in
  • Aircall
  • Azure Active Directory
  • Basecamp
  • Box
  • Calendly
  • ClickUp
  • Close
  • Datadog
  • Dialpad
  • DocuSign
  • Dropbox
  • FreeAgent
  • Freshdesk
  • Google Workspace
  • Gorgias
  • Help Scout
  • Humaans
  • Insightly
  • Jetbrains
  • Keap
  • Lever
  • Linear
  • Monday.com
  • Moneybird
  • Okta
  • Outreach
  • PandaDoc
  • Pipedrive
  • Salesflare
  • Salesforce
  • Sentry
  • Shortcut
  • Snowflake
  • Teamwork CRM
  • Twingate
  • Youtrack Hub
  • Zendesk
  • Zendesk Sell
  • Zoho CRM
  • Zoom
updated_at
string
The date and time the user was last updated
Supported in
  • Basecamp
  • Box
  • Calendly
  • Close
  • Confluence
  • Datadog
  • DocuSign
  • FreeAgent
  • Freshdesk
  • Gorgias
  • Help Scout
  • Humaans
  • Insightly
  • Keap
  • Linear
  • Moneybird
  • Okta
  • Outreach
  • PandaDoc
  • Pipedrive
  • Salesflare
  • Salesforce
  • Shortcut
  • Slack
  • Teamwork CRM
  • Twingate
  • Xero
  • Zendesk
  • Zendesk Sell
  • Zoho CRM
last_active_at
string
The date and time the user was last active
Supported in
  • Atlassian
  • ClickUp
  • Freshdesk
  • Grafana
  • Humaans
  • Jetbrains
  • Lever
  • Linear
  • Miro
  • Monday.com
  • Sentry
  • Youtrack Hub
  • Zendesk Sell
last_login_at
string
The date and time the user was last logged in
Supported in
  • Azure Active Directory
  • BambooHR
  • Capsule
  • DocuSign
  • Freshdesk
  • Google Workspace
  • Okta
  • Outreach
  • Pipedrive
  • Salesforce
  • Sentry
  • Smartsheet
  • Snowflake
  • Tableau
  • Zendesk
  • Zoom
status_changed_at
string
The date and time the user's status was last changed
Supported in
  • Gorgias
  • Linear
  • Okta
activated_at
string
The date and time the user was activated
Supported in
  • Close
  • Dialpad
  • Humaans
  • Monday.com
  • Okta
  • Outreach
  • Sentry
  • Teamwork CRM
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.