Sign in
Annotation

List annotations

Retrieve all annotation objects.

get/api/v1/annotations

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

statusstring
Example:to_review,reviewing

Annotation status, multiple values may be separated using a comma. See Annotation Lifecycle for available statuses.

modifierstring
Example:1,2,3

User ID(s)

confirmed_bystring
Example:1,2,3

User ID(s)

deleted_bystring
Example:1,2,3

User ID(s)

exported_bystring
Example:1,2,3

User ID(s)

purged_bystring
Example:1,2,3

User ID(s)

rejected_bystring
Example:1,2,3

User ID(s)

assigneesstring
Example:1,2,3

User ID(s)

labelsstring
Example:1,2,3

Label ID(s)

documentinteger

The document id.

queueinteger[]

Queue ID(s) filter

queue__workspacestring
Example:1,2,3

List of workspace ids separated by a comma.

relations__parentinteger

ID of parent annotation defined in related Relation object.

relations__typestring

Type of Relation that annotation belongs to.

relations__keystring

Key of Relation that annotation belongs to.

arrived_at_beforestring date-time

ISO 8601 timestamp (e.g. arrived_at_before=2019-11-15).

arrived_at_afterstring date-time

ISO 8601 timestamp (e.g. arrived_at_after=2019-11-14).

assigned_at_beforestring date-time

ISO 8601 timestamp (e.g. assigned_at_before=2019-11-15).

assigned_at_afterstring date-time

ISO 8601 timestamp (e.g. assigned_at_after=2019-11-14).

confirmed_at_beforestring date-time

ISO 8601 timestamp (e.g. confirmed_at_before=2019-11-15).

confirmed_at_afterstring date-time

ISO 8601 timestamp (e.g. confirmed_at_after=2019-11-14).

modified_at_beforestring date-time

ISO 8601 timestamp (e.g. modified_at_before=2019-11-15).

modified_at_afterstring date-time

ISO 8601 timestamp (e.g. modified_at_after=2019-11-14).

deleted_at_beforestring date-time

ISO 8601 timestamp (e.g. deleted_at_before=2019-11-15).

deleted_at_afterstring date-time

ISO 8601 timestamp (e.g. deleted_at_after=2019-11-14).

exported_at_beforestring date-time

ISO 8601 timestamp (e.g. exported_at_before=2019-11-14 22:00:00).

exported_at_afterstring date-time

ISO 8601 timestamp (e.g. exported_at_after=2019-11-14 12:00:00).

export_failed_at_beforestring date-time

ISO 8601 timestamp (e.g. export_failed_at_before=2019-11-14 22:00:00).

export_failed_at_afterstring date-time

ISO 8601 timestamp (e.g. export_failed_at_after=2019-11-14 12:00:00).

purged_at_beforestring date-time

ISO 8601 timestamp (e.g. purged_at_before=2019-11-15).

purged_at_afterstring date-time

ISO 8601 timestamp (e.g. purged_at_after=2019-11-14).

rejected_at_beforestring date-time

ISO 8601 timestamp (e.g. rejected_at_before=2019-11-15).

rejected_at_afterstring date-time

ISO 8601 timestamp (e.g. rejected_at_after=2019-11-14).

restricted_accessboolean

Boolean.

automatedboolean

Boolean.

has_email_thread_with_repliesboolean

Boolean (related email thread contains more than one incoming emails).

has_email_thread_with_new_repliesboolean

Boolean (related email thread contains unread incoming email).

searchstring

If this filter is used, annotations are filtered based on full-text search in annotation's datapoint values, original file name, modifier user email and messages.

Some special characters are ignored in the search term.

The results are limited to 10,000, any annotations over this limit will not be possible to list. We suggest narrowing down the search query if there are this many results.

Please beware that updates of the annotation search data are done asynchronously and are eventually consistent. Search may return inconsistent results temporarily (for a few seconds).

ordering'document' | '-document' | 'document__arrived_at' | '-document__arrived_at' | 'document__original_file_name' | '-document__original_file_name' | 'modifier' | '-modifier' | 'modifier__username' | '-modifier__username' | 'modified_by' | '-modified_by' | 'modified_by__username' | '-modified_by__username' | 'creator' | '-creator' | 'creator__username' | '-creator__username' | 'queue' | '-queue' | 'status' | '-status' | 'created_at' | '-created_at' | 'assigned_at' | '-assigned_at' | 'confirmed_at' | '-confirmed_at' | 'modified_at' | '-modified_at' | 'exported_at' | '-exported_at' | 'export_failed_at' | '-export_failed_at' | 'purged_at' | '-purged_at' | 'rejected_at' | '-rejected_at' | 'deleted_at' | '-deleted_at' | 'confirmed_by' | '-confirmed_by' | 'deleted_by' | '-deleted_by' | 'exported_by' | '-exported_by' | 'purged_by' | '-purged_by' | 'rejected_by' | '-rejected_by' | 'confirmed_by__username' | '-confirmed_by__username' | 'deleted_by__username' | '-deleted_by__username' | 'exported_by__username' | '-exported_by__username' | 'purged_by__username' | '-purged_by__username' | 'rejected_by__username' | '-rejected_by__username'

Result ordering.

fieldsstring

Comma-separated list of attributes to be included in the response. See the Query Field Filtering section for detailed explanation and available options.

fields!string

Comma-separated list of attributes to be excluded from the response. See the Query Field Filtering section for detailed explanation and available options.

sideloadstring

Comma-separated list of related objects to sideload (e.g., modifiers,documents,content). See the Sideloading section for detailed explanation and available options.

content.schema_idstring

Filter sideloaded content by schema_id (comma-separated list).

Response

OK

Example response

{
  "results": [
    {
      "id": 314528,
      "url": "https://example.rossum.app/api/v1/annotations/314159",
      "status": "to_review",
      "document": "https://example.rossum.app/api/v1/documents/456700",
      "queue": "https://example.rossum.app/api/v1/queues/8198",
      "schema": "https://example.rossum.app/api/v1/schemas/31336",
      "relations": [],
      "pages": [
        "https://example.rossum.app/api/v1/pages/558598"
      ],
      "creator": "https://example.rossum.app/api/v1/users/10775",
      "created_at": "2021-04-26T10:08:03.856648Z",
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z",
      "rir_poll_id": "54f6b9ecfa751789f71ddf12",
      "content": "https://example.rossum.app/api/v1/annotations/314159",
      "metadata": {
        "some_key": "some_value"
      },
      "related_emails": [],
      "email": "https://example.rossum.app/api/v1/emails/1234",
      "email_thread": "https://example.rossum.app/api/v1/email_threads/456",
      "has_email_thread_with_replies": true,
      "organization": "https://example.rossum.app/api/v1/organizations/406",
      "assignees": [
        "https://example.rossum.app/api/v1/users/1",
        "https://example.rossum.app/api/v1/users/2"
      ],
      "labels": [],
      "training_enabled": true
    }
  ]
}

Changes