ROrossum
Email Thread

List email threads

Changed on

Retrieve all email thread objects.

get/api/v1/email_threads

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

queueinteger[]

Queue ID(s) filter

created_at_beforestring date-time

Created before filter.

created_at_afterstring date-time

Created after filter.

has_root_emailboolean

Filter only email threads with a root email.

has_repliesboolean

Filter only email threads with two and more emails with type incoming.

has_new_repliesboolean

Filter only email threads with unread emails with type incoming.

last_email_created_at_beforestring date-time

Filter only email threads with the last email in the thread created before given timestamp.

last_email_created_at_afterstring date-time

Filter only email threads with the last email in the thread created after given timestamp.

recent_with_no_documents_not_repliedboolean

Filter only email threads with root email that arrived in the last 14 days with no attachment processed by Rossum, excluding those with rejected label, without any reply and when root email has been read.

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

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 1244,
      "url": "https://example.rossum.app/api/v1/email_threads/456",
      "organization": "https://example.rossum.app/api/v1/organizations/406",
      "queue": "https://example.rossum.app/api/v1/queues/8198",
      "root_email": "https://example.rossum.app/api/v1/emails/1234",
      "created_at": "2021-06-10T12:38:44.866180Z",
      "last_email_created_at": "2021-11-01T18:02:24.740600Z",
      "subject": "Root email subject",
      "from": {
        "email": "satisfied.customer@rossum.ai",
        "name": "Satisfied Customer"
      },
      "labels": [],
      "annotation_counts": {
        "annotations": 4,
        "annotations_processed": 2,
        "annotations_purged": 0,
        "annotations_rejected": 1,
        "annotations_unprocessed": 1
      }
    }
  ]
}

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

    • info

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