Appearance

Get Groups ​

Endpoint ​

http
GET /unified/user-directory/groups/{id}
Integrations supported
  • 15Five
  • Airtable
  • Amplitude SCIM
  • Asana
  • Asset Panda
  • Bitwarden
  • Confluence On Prem
  • Databricks
  • Dixa
  • Files.com
  • Fivetran
  • Freshservice
  • Front
  • HelloID
  • Heroku
  • Hootsuite
  • JFrog
  • Keeper
  • KnowBe4
  • LaunchDarkly
  • New Relic
  • Okta
  • OneLogin
  • Opsgenie
  • Pendo SCIM
  • Qlik Sense
  • Rollbar
  • Segment
  • Sigma Computing
  • Statsig
  • Survey Monkey
  • TalentLMS
  • TeamViewer
  • Teamwork Project Management
  • Vanta
  • Vercel
  • Wrike
  • Zoho Vault

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
group_type
string

Type of the group.

All possible enum values:
  • department
  • group
  • team
Enum support by integration
  • Freshservice
    • department
    • group
Required in
  • Freshservice
name
string

Name of the group.

Supported in
  • TeamViewer
user_id
string

The unique identifier for a user.

Required in
  • TeamViewer

Response Body ​

id
string
REQUIRED · 

Unique identifier for the group.

Supported in
  • 15Five
  • Airtable
  • Amplitude SCIM
  • Asana
  • Asset Panda
  • Bitwarden
  • Confluence On Prem
  • Databricks
  • Dixa
  • Files.com
  • Fivetran
  • Freshservice
  • Front
  • HelloID
  • Heroku
  • Hootsuite
  • JFrog
  • Keeper
  • KnowBe4
  • LaunchDarkly
  • New Relic
  • Okta
  • OneLogin
  • Opsgenie
  • Pendo SCIM
  • Qlik Sense
  • Rollbar
  • Segment
  • Sigma Computing
  • Statsig
  • Survey Monkey
  • TalentLMS
  • TeamViewer
  • Teamwork Project Management
  • Vanta
  • Vercel
  • Wrike
  • Zoho Vault
name
string

Name of the group.

Supported in
  • 15Five
  • Airtable
  • Amplitude SCIM
  • Asana
  • Asset Panda
  • Bitwarden
  • Confluence On Prem
  • Databricks
  • Dixa
  • Files.com
  • Fivetran
  • Freshservice
  • Front
  • HelloID
  • Heroku
  • Hootsuite
  • JFrog
  • Keeper
  • KnowBe4
  • LaunchDarkly
  • New Relic
  • Okta
  • OneLogin
  • Opsgenie
  • Pendo SCIM
  • Qlik Sense
  • Rollbar
  • Segment
  • Sigma Computing
  • Statsig
  • Survey Monkey
  • TalentLMS
  • TeamViewer
  • Teamwork Project Management
  • Vanta
  • Vercel
  • Wrike
  • Zoho Vault
description
string

Description of the group.

Supported in
  • Asana
  • Files.com
  • Fivetran
  • Freshservice
  • JFrog
  • LaunchDarkly
  • Okta
  • Opsgenie
  • Sigma Computing
  • TalentLMS
  • Teamwork Project Management
  • Vercel
  • Zoho Vault
organization
string

Unique identifier for the organization the group belongs to.

Supported in
  • Airtable
  • Asana
group_type
string

Type of the group.

All possible enum values:
  • team
  • department
  • group
Supported in
  • 15Five
  • Airtable
  • Amplitude SCIM
  • Asana
  • Asset Panda
  • Bitwarden
  • Confluence On Prem
  • Databricks
  • Files.com
  • Fivetran
  • Freshservice
  • Front
  • HelloID
  • Heroku
  • Hootsuite
  • JFrog
  • KnowBe4
  • LaunchDarkly
  • Okta
  • Opsgenie
  • Pendo SCIM
  • Qlik Sense
  • Rollbar
  • Segment
  • Sigma Computing
  • Statsig
  • Survey Monkey
  • TalentLMS
  • TeamViewer
  • Teamwork Project Management
  • Vercel
  • Wrike
  • Zoho Vault
created_at
string · date-time

Date and time when the group was created.

Supported in
  • 15Five
  • Airtable
  • Amplitude SCIM
  • Fivetran
  • Freshservice
  • Heroku
  • Hootsuite
  • Keeper
  • LaunchDarkly
  • Okta
  • Pendo SCIM
  • Qlik Sense
  • Sigma Computing
  • Survey Monkey
  • Teamwork Project Management
  • Vanta
  • Vercel
updated_at
string · date-time

Date and time when the group was last updated.

Supported in
  • Airtable
  • Amplitude SCIM
  • Freshservice
  • Heroku
  • Hootsuite
  • Keeper
  • LaunchDarkly
  • Okta
  • Pendo SCIM
  • Qlik Sense
  • Sigma Computing
  • Teamwork Project Management
  • Vercel
remote_data
object

Raw data returned from the remote API call.