Sign in
Document Relation

List document relations

Retrieve all document relation objects.

get/api/v1/document_relations

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

type'export' | 'einvoice'

Relation type. Multiple values may be separated using a comma.

annotationinteger[]

Annotation ID(s) filter

keystring

Document relation key

documentsinteger

ID of related document. Multiple values may be separated using a comma.

ordering'id' | '-id' | 'type' | '-type' | 'annotation' | '-annotation'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 1,
      "type": "export",
      "annotation": "https://example.rossum.app/api/v1/annotations/314159",
      "documents": [
        "https://example.rossum.app/api/v1/documents/124",
        "https://example.rossum.app/api/v1/documents/125"
      ],
      "url": "https://example.rossum.app/api/v1/document_relations/1"
    }
  ]
}

Changes

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