Docs

listUsers

Retrieves a list of User previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using Tags.

GET/v1/chat/users

Authorization

AuthorizationBearer
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-bp-authenticated-principalstring
Authenticated principal. Injected by the authentication middleware.
x-bot-idstring
Bot id
x-integration-id?string
Integration id
x-integration-alias?string
Integration alias

Query parameters

nextToken?string
Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results
pageSize?integer
Number of items to return per page (default 20, max 100)
conversationId?string
Filter by conversation id. This will return all users that have participated in the conversation.
tags?object
Filter by tags
afterDate?string
Date in ISO 8601 string with UTC timezone after which the user was created or updated (inclusive)
beforeDate?string
Date in ISO 8601 string with UTC timezone before which the user was created or updated (inclusive)
rangeField?enum<string>
Field used for range filtering. Allowed values are "updatedAt" or "createdAt". Defaults to "createdAt" if omitted.
Available options:"updatedAt","createdAt"
sortField?enum<string>
Sort results by this field
Available options:"updatedAt","createdAt"
sortDirection?enum<string>
Sort results in this direction
Available options:"asc","desc"

Response

Returns a list of User objects

usersobject[]
metaobject