Skip to main content
GET
/
v1
/
chat
/
users
List users
curl --request GET \
  --url https://unify.bundleup.io/v1/chat/users \
  --header 'Authorization: Bearer <token>' \
  --header 'BU-Connection-ID: <bu-connection-id>'
{
  "response": {
    "data": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "metadata": {
      "next": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Authorization
string
required

API Key for authentication

​
BU-Connection-ID
string
required

Connection ID for the integration

​
BU-Max-Retries
string | null
default:3

Maximum number of retries for the request

Query Parameters

​
include_raw
enum<string> | null
default:false

Whether to include raw response from the provider

Available options:
true,
false
​
params
string

Optional passthrough parameter

Example:

"{\"team_id\":\"12345\"}"

​
limit
number
default:100

Number of users to return

Required range: 1 <= x <= 100
​
after
string

Cursor for pagination

Response

Successful Response For users

​
response
object
required