Sign in
Upload

Retrieve upload

Returns upload object.

get/api/v1/uploads/{uploadID}

Path parameters

uploadIDinteger required

Upload ID

Response

OK

idinteger required

ID of the upload.

urlstring url required

Upload object URL.

queuestring uri required

Queue URL.

creatorstring url nullable required

URL of the user who created the upload.

created_atstring date-time required

Time of the creation of the upload.

emailstring url nullable required

URL of the email that created the upload object (if applicable).

organizationstring uri required

Organization URL.

documentsstring[] required

URLs of the uploaded documents.

additional_documentsstring[] nullable required

URLs of additional documents created in upload.created event hooks.

annotationsstring[] nullable required

URLs of all created annotations.

Example response

{
  "id": 314528,
  "url": "https://example.rossum.app/api/v1/uploads/314528",
  "queue": "https://example.rossum.app/api/v1/queues/8198",
  "creator": "https://example.rossum.app/api/v1/users/1",
  "created_at": "2021-04-26T10:08:03.856648Z",
  "email": "https://example.rossum.app/api/v1/emails/96743",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "documents": [
    "https://example.rossum.app/api/v1/documents/254322",
    "https://example.rossum.app/api/v1/documents/254323"
  ],
  "additional_documents": [
    "https://example.rossum.app/api/v1/documents/254324"
  ],
  "annotations": [
    "https://example.rossum.app/api/v1/annotations/104322",
    "https://example.rossum.app/api/v1/annotations/104323",
    "https://example.rossum.app/api/v1/annotations/104324"
  ]
}

Changes

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