Skip to content
/Email Inboxes

Return filtered email inboxes

Request

POST /v3/email-inboxes/library

Get all email inboxes that meet the filtering criteria

Security
API_Key
Query
pageinteger, >= 0

Number of results page of an endpoint with paginated results

Default:0
pageSizeinteger, [ 100 .. 1000 ]
Default:100
sortBystring
Default:"name"
Enum:"name""emailAddress""messagesReceived""lastMessageReceived""testScenariosCount"
sortDescboolean

Controls sorting order

Default:false
Bodyapplication/jsonrequired

Filter params

namestring
Example:"Adobe Campaign Holidays, Marketing Department"
emailAddressstring
Example:"scanTest+<8^[a-z0-9]>-<truncatedInboxName>@email.observepoint.com"
auditIdsArray of integers, (int64)

The ids of the audits to be associated to the Email Inbox

labelIdsArray of integers

The ids of the labels to be associated to the Email Inbox

createdByArray of integers

The ids of Email Inbox owners

POST
/v3/email-inboxes/library
curl -i -X POST \
  'https://api.observepoint.com/v3/email-inboxes/library?page=0&pageSize=100&sortBy=name&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Adobe Campaign Holidays, Marketing Department",
    "emailAddress": "scanTest+<8^[a-z0-9]>-<truncatedInboxName>@email.observepoint.com",
    "auditIds": [
      0
    ],
    "labelIds": [
      223
    ],
    "createdBy": [
      123
    ]
  }'

Responses

Successful operation

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

emailInboxesArray of objectsrequired
Response
{
  "metadata": {
    "pagination": { … }
  },
  "emailInboxes": [
    { … }
  ]
}