Get all users on a team

GET

reseller

teams

{teamId}

users

curl --request GET \
  --url https://partners.clerk.chat/reseller/teams/{teamId}/users

{
  "data": [
    {
      "id": "<string>",
      "firstname": "<string>",
      "lastname": "<string>",
      "email": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "inboxes": [
        {
          "id": "<string>",
          "phone": "<string>",
          "externalId": "<string>",
          "created": "2023-11-07T05:31:56Z",
          "updated": "2023-11-07T05:31:56Z"
        }
      ],
      "role": {
        "type": "workspace_owner"
      },
      "acceptedTermsOfService": true
    }
  ],
  "total": 123
}

Path Parameters

teamId

string

required

Query Parameters

query

string

Search by name

skip

number

How many to skip

take

number

How many to return

Response

200 - application/json

data

object[]

required

total

number

required

Create new inboxes and users for a team Add a user to a team

curl --request GET \
  --url https://partners.clerk.chat/reseller/teams/{teamId}/users

{
  "data": [
    {
      "id": "<string>",
      "firstname": "<string>",
      "lastname": "<string>",
      "email": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "inboxes": [
        {
          "id": "<string>",
          "phone": "<string>",
          "externalId": "<string>",
          "created": "2023-11-07T05:31:56Z",
          "updated": "2023-11-07T05:31:56Z"
        }
      ],
      "role": {
        "type": "workspace_owner"
      },
      "acceptedTermsOfService": true
    }
  ],
  "total": 123
}