List email submissions

List inbound email submissions to your Terminal49 account with filters and includes, useful for auditing parsed documents and reference linking outcomes.

GET /email_submissions

List email submissions

cURL

curl --request GET \
  --url https://api.terminal49.com/v2/email_submissions \
  --header 'Authorization: <api-key>'

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "subject": "<string>",
        "body": "<string>",
        "from": [
          "<string>"
        ],
        "to": [
          "<string>"
        ],
        "cc": [
          "<string>"
        ],
        "sent_at": "2023-11-07T05:31:56Z",
        "message_id": "<string>",
        "in_reply_to": "<string>",
        "references": [
          "<string>"
        ],
        "content_type": "<string>",
        "documents_count": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "account": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "user": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        },
        "documents": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            }
          ]
        }
      },
      "links": {
        "self": "<string>"
      }
    }
  ],
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "attributes": {
        "company_name": "<string>"
      }
    }
  ],
  "links": {
    "last": "<string>",
    "next": "<string>",
    "prev": "<string>",
    "first": "<string>",
    "self": "<string>"
  },
  "meta": {
    "size": 123,
    "total": 123
  }
}

Authorizations

Authorization · string · header · required

Use a Terminal49 API key in the Authorization header with the Token prefix.

Authorization: Token YOUR_API_KEY

Query Parameters

include · string

Allowed: account, user, documents, documents.last_document_representation. Defaults to documents + documents.last_document_representation.

page[number] · integer

Required range: x >= 1

page[size] · integer

Required range: x >= 1

Response

200

application/json

OK

data · Email Submission · object[]

Show child attributes

included · (Account model · object | any | Email Submission Document · object | Document Representation · object)[]

Show child attributes

links · links · object

Show child attributes

meta · meta · object

Show child attributes