List an account's emails

Lists the emails sent to or from an account, a page at a time.

GET /accounts/{account_id}/communications/emails

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/accounts/ACC0001/communications/emails?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

200

{
  "data": [
    {
      "additional_template": "<unknown>",
      "attachments": [
        {
          "file_path": "<string>",
          "name": "<string>",
          "path": "<string>",
          "size": 123,
          "type": "<string>"
        }
      ],
      "bcc": "<array>",
      "body": "<unknown>",
      "cc": "<array>",
      "created_by": "<unknown>",
      "created_on": "<string>",
      "from": "<unknown>",
      "id": "<string>",
      "last_updated_by": "<unknown>",
      "last_updated_on": "<unknown>",
      "mail_type": "<string>",
      "message_type": "<string>",
      "object": "<string>",
      "status": "<string>",
      "subject": "<unknown>",
      "to": "<string>",
      "uuid": "<string>"
    }
  ],
  "object": "<string>",
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  },
  "url": "<string>"
}

Returns the emails under data, with pagination for the next page. Use an email’s uuid to retrieve or delete it.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

account_id · string · required

The account's id, such as ACC0001. Not its uuid.

Query Parameters

limit · integer

The most emails to return on one page.

Example:

20

cursor · string

The pagination.next_cursor from the previous page, to fetch the next page.

sort · string

The field to sort by, such as created_on. Prefix it with - for descending order, as in -created_on.

Response

200 - application/json

One page of emails.

data · object[]

Show child attributes

object · string

pagination · object

How to fetch the next page.

Show child attributes

url · string