ROrossum
Email

List emails

Changed on

Retrieve all emails objects.

get/api/v1/emails

Request

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

created_at_beforestring date-time

Filter emails created before this date

created_at_afterstring date-time

Filter emails created after this date

subjectstring

Filter by email subject

queueinteger[]

Queue ID(s) filter

inboxinteger

Filter by inbox ID

documentsinteger

Filter by document ID

from__emailstring email

Filter by sender email address

from__namestring

Filter by sender name

tostring email

Filter by recipient email address

last_thread_email_created_at_beforestring date-time

Filter emails with last thread email created before this date

last_thread_email_created_at_afterstring date-time

Filter emails with last thread email created after this date

type'incoming' | 'outgoing'

Filter by email type

email_threadinteger

Filter by email thread ID

has_documentsboolean

Filter emails that have or don't have documents

ordering'id' | '-id' | 'created_at' | '-created_at' | 'subject' | '-subject' | 'queue' | '-queue' | 'inbox' | '-inbox' | 'from__email' | '-from__email' | 'from__name' | '-from__name'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 1234,
      "url": "https://example.rossum.app/api/v1/emails/1234",
      "queue": "https://example.rossum.app/api/v1/queues/8198",
      "inbox": "https://example.rossum.app/api/v1/inboxes/1229",
      "parent": "https://example.rossum.app/api/v1/emails/1234",
      "email_thread": "https://example.rossum.app/api/v1/email_threads/456",
      "children": [
        "https://example.rossum.app/api/v1/emails/1244"
      ],
      "documents": [
        "https://example.rossum.app/api/v1/documents/5678"
      ],
      "created_at": "2021-03-26T14:31:46.993427Z",
      "last_thread_email_created_at": "2021-03-27T14:29:48.665478Z",
      "subject": "Some email subject",
      "from": {
        "email": "company@east-west.com",
        "name": "Company East"
      },
      "to": [
        {
          "email": "east-west-trading-co-a34f3a@example.rossum.app",
          "name": "East West Trading"
        }
      ],
      "cc": [],
      "bcc": [],
      "body_text_plain": "Some body",
      "body_text_html": "<div dir=\"ltr\">Some body</div>",
      "metadata": {
        "some_key": "some_value"
      },
      "type": "outgoing",
      "annotation_counts": {
        "annotations": 3,
        "annotations_processed": 1,
        "annotations_unprocessed": 1,
        "annotations_rejected": 1
      },
      "annotations": [
        "https://example.rossum.app/api/v1/annotations/1",
        "https://example.rossum.app/api/v1/annotations/2",
        "https://example.rossum.app/api/v1/annotations/4"
      ],
      "related_annotations": [],
      "related_documents": [
        "https://example.rossum.app/api/v1/documents/3"
      ],
      "creator": "https://example.rossum.app/api/v1/users/10775",
      "filtered_out_document_count": 2,
      "labels": [
        "rejected"
      ],
      "content": "https://example.rossum.app/api/v1/emails/1234"
    }
  ]
}

Changes

  • f1b5a910991dRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added subschema #2 to the / response property allOf list for the response status