GET
/
users
List users
curl --request GET \
  --url https://api.amplemarket.com/users \
  --header 'Authorization: Bearer <token>'
{
  "users": [
    {
      "id": "0198f652-73a2-7d41-914e-e511382bb808",
      "name": "Example User",
      "email": "user@example.com",
      "status": "active",
      "role": "sales_rep",
      "mailboxes": [
        {
          "id": "0198f652-73c9-752f-a93e-128fac602668",
          "email": "mailbox@example.com"
        }
      ]
    }
  ],
  "_links": {
    "self": {
      "href": "/users?page[size]=20"
    }
  }
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page[size]
string

Page size

page[after]
string

Page after

page[before]
string

Page before

status
string

Filter by user status

role
string

Filter by user role

email
string

Filter by user email

Response

200 - application/json

successful

The response is of type object.