Sign in
Saved View

Create saved view

Create a new saved view object.

post/api/v1/saved_views

Request body

idinteger

Saved view object ID.

urlstring uri

Saved view object URL.

namestring

Name of the saved view shown in the UI.

queryobject

Filter definition of the saved view in the query format of search annotations.

sharedboolean

When true the saved view is shared with other users of its queues_filter queues or organization.

queues_filterstring[]

Queues the saved view is used on. When empty, the saved view is used on all queues of its creator (personal) or organization (shared).

organizationstring uri

Organization URL.

created_bystring uri

User who created the saved view.

created_atstring date-time

Timestamp of the saved view creation.

modified_bystring uri nullable

User that last modified the object.

modified_atstring date-time nullable

Timestamp of last modification.

Example request

{
  "id": 123,
  "url": "https://example.rossum.app/api/v1/saved_views/123",
  "name": "High amount invoices",
  "query": {
    "$and": [
      {
        "status": {
          "$in": [
            "to_review"
          ]
        }
      }
    ]
  },
  "queues_filter": [
    "https://example.rossum.app/api/v1/queues/101"
  ],
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "created_by": "https://example.rossum.app/api/v1/users/9524",
  "created_at": "2026-01-01T15:02:25.653324Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Response

Created

idinteger required

Saved view object ID.

urlstring uri required

Saved view object URL.

namestring required

Name of the saved view shown in the UI.

queryobject required

Filter definition of the saved view in the query format of search annotations.

sharedboolean required

When true the saved view is shared with other users of its queues_filter queues or organization.

queues_filterstring[] required

Queues the saved view is used on. When empty, the saved view is used on all queues of its creator (personal) or organization (shared).

organizationstring uri required

Organization URL.

created_bystring uri required

User who created the saved view.

created_atstring date-time required

Timestamp of the saved view creation.

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

Example response

{
  "id": 123,
  "url": "https://example.rossum.app/api/v1/saved_views/123",
  "name": "High amount invoices",
  "query": {
    "$and": [
      {
        "status": {
          "$in": [
            "to_review"
          ]
        }
      }
    ]
  },
  "queues_filter": [
    "https://example.rossum.app/api/v1/queues/101"
  ],
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "created_by": "https://example.rossum.app/api/v1/users/9524",
  "created_at": "2026-01-01T15:02:25.653324Z",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.