Should you notice any errors in our documentation, please don’t hesitate to contact us. Thank you!

List Users

GET

/users

Last modified:2026-03-31 13:51:02

x-allowed-tags:["any_view","any_manage"]

x-allow-access:["Public::User"]

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

Body Params application/x-www-form-urlencoded

Responses

🟢200

application/json

get User(s)

Body

🟠401

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '/users?sort&skip_meta_totals&page[number]&page[size]' \
--header 'Authorization: Bearer <token>' \
--data-urlencode 'multiplier_ids=' \
--data-urlencode 'customer_ids='

Response Example

200 - Example 1

{
    "meta": {
        "total_pages": 0,
        "current_page": 0,
        "page_size": 0,
        "total_entries": 0
    },
    "data": [
        {
            "id": "string",
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "email": "user@example.com",
            "name": "string",
            "expires_at": null,
            "contract_ids": [
                "string"
            ],
            "confirmed": true,
            "is_deletable": true,
            "user_roles": [
                {
                    "id": "string",
                    "role": {
                        "id": "string",
                        "name": "string",
                        "display_name": "string",
                        "access_tags": [
                            "string"
                        ],
                        "created_at": "2019-08-24T14:15:22.123Z",
                        "updated_at": "2019-08-24T14:15:22.123Z"
                    },
                    "created_at": "2019-08-24T14:15:22.123Z",
                    "updated_at": "2019-08-24T14:15:22.123Z"
                }
            ]
        }
    ],
    "links": {
        "self": "http://example.com",
        "first": "http://example.com",
        "prev": null,
        "next": null,
        "last": "http://example.com"
    }
}

Modified at 2026-03-31 13:51:02

Roles User

Get User