Retrieve all users.

Returns all users from the sender selected-space.

💡 Response can be filtered using 3 parameters:

• limit: The maximum number of users to return.
• offset: The starting index for the results (for pagination).
• sort: Whether results are sorted ascending (true) or descending (false) by surname then firstname. Default: true.

GET /users

Retrieve all users.

cURL

curl --request GET \
  --url https://incoming.qomon.app/users \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "success",
  "data": {
    "count": 100,
    "teams": null,
    "users": [
      {
        "created_at": "2025-04-23T08:16:26.08912Z",
        "updated_at": "2025-04-30T09:55:59.320084Z",
        "deleted_at": "2025-04-30T09:55:59.320084Z",
        "address": "1 rue de la paix",
        "birthdate": "1999-03-06T23:00:00Z",
        "city": "Paris",
        "created": "2025-04-23T08:16:26.088746Z",
        "firstname": "John",
        "group_id": 1,
        "id": 101,
        "locale": "en",
        "location": "1.826483,-1.549486",
        "mail": "[e-mail]",
        "phone": "0123456789",
        "postal": "75000",
        "role": "user",
        "role_data": {
          "id": 5,
          "name": "user",
          "order": 1,
          "type": "user"
        },
        "selected_group_id": [
          1
        ],
        "surname": "DohnJoe"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit · integer<uint>

Optional. The maximum number of users to return.

Required range: x >= 1

offset · integer<uint>

Optional. The starting index for the results (for pagination).

Required range: x >= 0

sort · boolean

Optional. Indicates whether the results should be sorted ascending (true) or descending (false) by surname then firstname. Default value is true.

Response

200

application/json

OK

status · string

Example:

"success"

data · object

Show child attributes