Appearance

List Groups ​

Endpoint ​

http
GET /unified/user-directory/groups
Integrations supported
  • 15Five
  • Asana
  • Bitwarden
  • Confluence
  • Databricks
  • Fivetran
  • Front
  • JFrog
  • Jira
  • Keeper
  • Leadsquared
  • Netlify
  • New Relic
  • Okta
  • OpenVPN
  • Qlik Sense
  • Salesloft
  • Segment
  • Sendoso
  • Survey Monkey
  • Vercel
  • Zoho Vault
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.

  • 15Five
  • JFrog

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_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
organization_id
string

Unique identifier of the organization to fetch the teams for.

Required in
  • Asana
created_at
string · date-time

Date and time when the group was created.

Supported in
  • Salesloft
  • Vercel
name
string

Name of the group.

Supported in
  • 15Five
  • Databricks
  • New Relic
group_type
string

Type of the group.

All possible enum values:
  • department
  • group
  • team
Enum support by integration
  • Fivetran
    • team
    • group
  • Leadsquared
    • team
    • group
  • Salesloft
    • team
    • group
Required in
  • Fivetran
  • Leadsquared
  • Salesloft
user_id
string

Set this value when group_type = group.

Supported in
  • Leadsquared
id
string

Unique identifier for the group.

Supported in
  • Salesloft
updated_at
string · date-time

Date and time when the group was last updated.

Supported in
  • Salesloft
sort_by
string

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

Supported in
  • Qlik Sense

Response Body ​

result
object[]

List of Groups

id
string
REQUIRED · 

Unique identifier for the group.

Supported in
  • 15Five
  • Asana
  • Bitwarden
  • Confluence
  • Databricks
  • Fivetran
  • Front
  • JFrog
  • Jira
  • Keeper
  • Leadsquared
  • Netlify
  • New Relic
  • Okta
  • OpenVPN
  • Qlik Sense
  • Salesloft
  • Segment
  • Sendoso
  • Survey Monkey
  • Vercel
  • Zoho Vault
name
string

Name of the group.

Supported in
  • 15Five
  • Asana
  • Bitwarden
  • Confluence
  • Databricks
  • Fivetran
  • Front
  • JFrog
  • Jira
  • Keeper
  • Leadsquared
  • Netlify
  • New Relic
  • Okta
  • OpenVPN
  • Qlik Sense
  • Salesloft
  • Segment
  • Sendoso
  • Survey Monkey
  • Vercel
  • Zoho Vault
description
string

Description of the group.

Supported in
  • Asana
  • Fivetran
  • Leadsquared
  • Okta
  • Vercel
  • Zoho Vault
organization
string

Unique identifier for the organization the group belongs to.

Supported in
  • Asana
group_type
string

Type of the group.

All possible enum values:
  • team
  • department
  • group
Supported in
  • 15Five
  • Asana
  • Bitwarden
  • Confluence
  • Databricks
  • Fivetran
  • Front
  • JFrog
  • Leadsquared
  • Netlify
  • Okta
  • OpenVPN
  • Qlik Sense
  • Salesloft
  • Segment
  • Sendoso
  • Survey Monkey
  • Vercel
  • Zoho Vault
created_at
string · date-time

Date and time when the group was created.

Supported in
  • Fivetran
  • Keeper
  • Leadsquared
  • Netlify
  • Okta
  • Qlik Sense
  • Salesloft
  • Sendoso
  • Vercel
updated_at
string · date-time

Date and time when the group was last updated.

Supported in
  • Keeper
  • Leadsquared
  • Netlify
  • Okta
  • Qlik Sense
  • Salesloft
  • Sendoso
  • Vercel
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.