List Users API - ChakraHQ APIs

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

_data

array [object {25}]

required

id

string

optional

createdAt

integer

optional

updatedAt

integer

optional

username

string

optional

firstName

string

optional

lastName

string

optional

middleName

string

optional

displayName

string

optional

gender

string

optional

dob

integer

optional

bio

string

optional

profileImageUrl

string

optional

coverImageUrl

string

optional

timezone

string

optional

data

null

optional

onboardingData

null

optional

isActive

boolean

optional

isDeleted

boolean

optional

deletedAt

null

optional

availabilityStatus

string

optional

team

string

optional

role

string

optional

primaryEmail

object

optional

primaryPhone

null

optional

profile

null

optional

Example

{
  "_data": [
    {
      "id": "string",
      "createdAt": 0,
      "updatedAt": 0,
      "username": "string",
      "firstName": "string",
      "lastName": "string",
      "middleName": "string",
      "displayName": "string",
      "gender": "string",
      "dob": 0,
      "bio": "string",
      "profileImageUrl": "string",
      "coverImageUrl": "string",
      "timezone": "string",
      "data": null,
      "onboardingData": null,
      "isActive": true,
      "isDeleted": true,
      "deletedAt": null,
      "availabilityStatus": "string",
      "team": "string",
      "role": "string",
      "primaryEmail": {
        "id": "string",
        "createdAt": 0,
        "updatedAt": 0,
        "email": "string",
        "normalizedEmail": "string",
        "type": "string",
        "isVerified": true,
        "user": "string"
      },
      "primaryPhone": null,
      "profile": null
    }
  ]
}