Skip to main content
GET
/
mailboxes
List mailboxes
curl --request GET \
  --url https://api.amplemarket.com/mailboxes \
  --header 'Authorization: Bearer <token>'
{
  "mailboxes": [
    {
      "id": "<string>",
      "email": "<string>",
      "email_provider": "google",
      "daily_email_limit": 123,
      "status": "active",
      "user": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "_links": {
    "self": {
      "href": "<string>"
    },
    "prev": {
      "href": "<string>"
    },
    "next": {
      "href": "<string>"
    }
  }
}

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 (max 20)

​
page[after]
string

Page after

​
page[before]
string

Page before

​
status
enum<string>

Filter by mailbox status

Available options:
active,
inactive,
needs_reconnection
​
email_provider
enum<string>

Filter by email provider

Available options:
google,
outlook,
other,
other_mixed
​
user_email
string

Filter by user email

Response

200 - application/json

Successful

​
mailboxes
object[]
​
_links
object