Skip to content
/
Get Email Inbox by id

Get Email Inbox by id

Request

GET /v3/email-inboxes/{emailInboxId}

Get a Email Inbox by id

Security
API_Key
Path
emailInboxIdintegerrequired

Unique identification number for email inbox

GET
/v3/email-inboxes/{emailInboxId}
curl -i -X GET \
  'https://api.observepoint.com/v3/email-inboxes/{emailInboxId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation, resource found

Bodyapplication/json
idinteger, (int64)required
Example:10
labelIdsArray of integers, uniquerequired

The ids of the labels associated to the Email Inbox

namestringrequired
Example:"Christmas Marketing Campaign"
emailAddressstringrequired

The email address that has been assigned to the inbox

Example:"scanTest+<8^[a-z0-9]>@email.observepoint.com"
notesstring
subscribersobject
linkExclusionFiltersArray of stringsrequired
Response
{
  "id": 10,
  "labelIds": [
    223
  ],
  "name": "Christmas Marketing Campaign",
  "emailAddress": "scanTest+<8^[a-z0-9]>@email.observepoint.com",
  "notes": "string",
  "subscribers": {
    "onReceived": [ … ],
    "onProcessed": [ … ]
  },
  "linkExclusionFilters": [
    "string"
  ],
  "omitSocialLinks": true
}