GET
/
public
/
admin
/
users
curl --request GET \
  --url https://web-api.clerk.chat/public/admin/users \
  --header 'apiKey: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "role": "<string>"
    }
  ],
  "links": {
    "next": "<string>",
    "prev": "<string>",
    "self": "<string>"
  },
  "total": 1
}

Authorizations

​
apiKey
string
header
required

Query Parameters

​
emails
string[]

Email of the user to search

Example:
["+1415456789"]

Response

201
application/json
The created Clerk chat user
​
data
object[]
required

Response containing Clerk chat user information

​
total
number
required

The total number of users

Example:

1

​
links
object