Skip to content

List Members

Endpoint

http
GET /unified/instant-messaging/members
Integrations supported
  • Slack

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

Response Body

result
object[]

List of Members

id
string
REQUIRED · 

The unique identifier for a member

Supported in
  • Slack
first_name
string

The first name of the member

Supported in
  • Slack
last_name
string

The last name of the member

Supported in
  • Slack
title
string

The title of the member

Supported in
  • Slack
name
string

The name of the member

Supported in
  • Slack
username
string

The username of the member

Supported in
  • Slack
emails
object[]

The emails of the member

Supported in
  • Slack
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 member

Supported in
  • Slack
number
string

The phone number

extension
string

The extension of the phone number

type
string

The type of phone number

status
string

The status of the member. If no clear mapping is available, then the raw value is returned.

All possible enum values:
  • active
  • inactive
  • deleted
  • invited
Supported in
  • Slack
is_email_verified
boolean

Whether the member's email has been verified

Supported in
  • Slack
organizations
object[]

The organizations of the member

id
string

The unique identifier for an organization

name
string

The name of the organization

workspaces
object[]

The workspaces of the member

id
string

The unique identifier for a workspace

name
string

The name of the worksapce

type
string

The type of member

Supported in
  • Slack
groups
object[]

The groups of the member

id
string

The unique identifier for a group

name
string

The name of the group

type
string

The type of group

organization
object

The organization of the group

id
string

The unique identifier for an organization

name
string

The name of the organization

workspace
object

The workspace of the group

id
string

The unique identifier for a workspace

name
string

The name of the workspace

avatar
string

The avatar of the member

Supported in
  • Slack
timezone
string

The timezone of the member

Supported in
  • Slack
languages
string[]

The languages preferred by the member

bio
string

The bio of the member

Supported in
  • Slack
created_at
string · date-time

The date and time the member was created

updated_at
string · date-time

The date and time the member was last updated

Supported in
  • Slack
last_active_at
string · date-time

The date and time the member was last active

last_login_at
string · date-time

The date and time the member was last logged in

status_changed_at
string · date-time

The date and time the member's status was last changed

activated_at
string · date-time

The date and time the member was activated

urls
object[]

The URLs of the member

url
string

The URL

type
string

The type of URL

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.