Get list of users

GET 
/users

List of all users

Request

Query Parameters

email stringrequired
Email to search user
Example: [email protected]
page stringrequired
Page to return, default 1
Example: 1
group_id stringrequired
Get users of a specific group
Example: 6589
search stringrequired
Search users with text
Example: text
client_user_id stringrequired
Get user with a specific custom client_user_id (useful for integrations)
Example: string_integration

Header Parameters

Accept stringrequired
Example: application/json

Responses

200

Response Headers

application/json

Schema

Schema

status stringrequired

users

object[]

required

Array [

id stringrequired

group stringrequired

group_list stringrequired

avatar stringrequired

email stringrequired

level stringrequired

username stringrequired

date stringrequired

language stringrequired

is_user stringrequired

client_user_id stringrequired

]

Example (from schema)

{
  "status": "string",
  "users": [
    {
      "id": "string",
      "group": "string",
      "group_list": "string",
      "avatar": "string",
      "email": "string",
      "level": "string",
      "username": "string",
      "date": "string",
      "language": "string",
      "is_user": "string",
      "client_user_id": "string"
    }
  ]
}

1

OK

{
  "status": "<string>",
  "users": [
    {
      "id": "<string>",
      "group": "<string>",
      "group_list": "<string>",
      "avatar": "<string>",
      "email": "<string>",
      "level": "<string>",
      "username": "<string>",
      "date": "<string>",
      "language": "<string>",
      "is_user": "<string>",
      "client_user_id": "<string>"
    },
    {
      "id": "<string>",
      "group": "<string>",
      "group_list": "<string>",
      "avatar": "<string>",
      "email": "<string>",
      "level": "<string>",
      "username": "<string>",
      "date": "<string>",
      "language": "<string>",
      "is_user": "<string>",
      "client_user_id": "<string>"
    }
  ]
}

400

Response Headers

application/json

Schema

Schema

status stringrequired

Example (from schema)

{
  "status": "string"
}

1

Bad Request

{
  "status": "<string>"
}

401

Response Headers

application/json

Schema

Schema

status stringrequired

Example (from schema)

{
  "status": "string"
}

1

Unauthorized

{
  "status": "<string>"
}

404

Response Headers

application/json

Schema

Schema

status stringrequired

Example (from schema)

{
  "status": "string"
}

1

Not Found

{
  "status": "<string>"
}

Loading...