List users

GET

/space/user

const url = 'https://api.aelyst.ai/v1/space/user?limit=10';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.aelyst.ai/v1/space/user?limit=10' \
  --header 'Authorization: Bearer <token>'

Get a list of users in your workspace.

Users with pending invitations are not included in the response.

Authorizations

BearerAuth

Parameters

Query Parameters

limit

integer

default: 10 >= 1 < 100 >= 1 characters <= 100 characters

Number of items to return i.e. page size.

cursorId

integer

Pointer to the contact id from where the next batch of records should start from.

Responses

200

application/json

object

items

Array<object>

object

required

User ID.

integer

firstName

required

string

lastName

required

string

email

required

string

role

required

User role in the workspace.

string

Allowed values: agent manager owner

team

required

object

ID of the team.

integer

name

Name of the team.

string

restrictions

required

Any of:

Array<string>

Constants representing the user restrictions at the workspace-level.

Array<string>

unique items

Allowed values: restrict_data_export restrict_contact_deletion restrict_space_setting show_team_contacts show_only_mine restrict_space_integration restrict_shortcuts

pagination

object

next

required

string

previous

required

string

Example

{
  "items": [
    {
      "id": 123,
      "firstName": "John",
      "lastName": "Wick",
      "email": "test@example.com",
      "role": "agent",
      "team": {
        "id": 123,
        "name": "Customer Support"
      },
      "restrictions": [
        "restrict_data_export"
      ]
    }
  ],
  "pagination": {
    "next": "https://api.aelyst.ai/space/user?limit=10&cursorId=10",
    "previous": "https://api.aelyst.ai/space/user?limit=10&cursorId=-10"
  }
}

400

application/json

object

code

integer

message

string

Example

{
  "code": 400,
  "message": "Validation error."
}

401

application/json

object

code

integer

message

string

Example

{
  "code": 401,
  "message": "UN_AUTHORIZED"
}

429

application/json

object

code

integer

message

string

Example

{
  "code": 429,
  "message": "Too Many Requests"
}

Headers

Retry-After

number

Example

Number of seconds until you can retry the request

X-RateLimit-Limit

number

Example

Number of request allowed for this end point

X-RateLimit-Remaining

number

Example

Number of request remaining for this end point

500

application/json

object

code

integer

message

string

Example

{
  "code": 500,
  "message": "Unexpected error occurred"
}