GET
/
users
curl --request GET \
  --url https://api.amplemarket.com/users \
  --header 'Authorization: Bearer <token>'
{
  "users": [
    {
      "id": "0196b4f9-3f83-7d94-9c78-7157796e0422",
      "name": "Example User",
      "email": "user@example.com",
      "status": "active",
      "role": "sales_rep",
      "mailboxes": [
        {
          "id": "0196b4f9-3fbb-7157-a7dd-544f60bf1dc6",
          "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.