User

Get users

Retrieve all users in an organization.

Permissions

This endpoint is impacted by the following permissions:

Only users that the authenticated user has the User:GetUserInfo permission for are returned.

get/v1/{organization}/user/

Request

Base URL
https://api.amigo.ai
Auth
HTTP bearer and API key in header X-ORG-ID and HTTP basic
TypeScript
https://skmtc.dev/amigo/apis/amigo-api/docs/v1/:organization/user/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationstring required

Query parameters

user_idstring[]

The ID of the user.

emailstring[]

The email of the user.

limitinteger

The maximum number of users to retrieve.

continuation_tokeninteger

The token from the previous request to return the next page of users.

sort_bystring[]

The fields to sort the sets by. Supported fields are first_name, last_name, email, user_stats.num_conversations, user_stats.num_messages, and user_stats.last_message_time. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.

has_moreboolean required

Whether there are more users to retrieve.

continuation_tokeninteger nullable required

A token to supply to the next request to retrieve the next page of users. Only populated if has_more is True.

Changes

No operation changes recorded.