Document
List documents
Returns paginated response with a list of document objects.
get/api/v1/documents
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
emailinteger[]
ID(s) of email object(s)
creatorinteger[]
ID(s) of user(s) that created the object
created_at_beforestring date-time
Created before filter.
created_at_afterstring date-time
Created after filter.
arrived_at_beforestring date-time
Same as created_at_before.
arrived_at_afterstring date-time
Same as created_at_after.
original_file_namestring
Name of the document filter
attachment_status'null' | 'filtered_by_inbox_resolution' | 'filtered_by_inbox_size' | 'filtered_by_inbox_mime_type' | 'filtered_by_inbox_file_name' | 'filtered_by_hook_custom' | 'filtered_by_queue_mime_type' | 'hook_additional_file' | 'hook_converted' | 'filtered_by_insecure_mime_type' | 'extracted_archive' | 'failed_to_extract' | 'processed' | 'password_protected_archive' | 'broken_image' nullable
Reason why the Document got filtered out on Email ingestion.
Example:processed
Attachment status filter
parentinteger
ID of parent document filter
ordering'id' | '-id' | 'arrived_at' | '-arrived_at' | 'created_at' | '-created_at' | 'original_file_name' | '-original_file_name' | 'mime_type' | '-mime_type' | 'attachment_status' | '-attachment_status'
Result ordering.
Response
OK
Example response
{
"results": [
{
"id": 314628,
"url": "https://example.rossum.app/api/v1/documents/314628",
"s3_name": "272c2f01ae84a4e19a421cb432e490bb",
"parent": "https://example.rossum.app/api/v1/documents/203517",
"email": "https://example.rossum.app/api/v1/emails/1234",
"annotations": [
"https://example.rossum.app/api/v1/annotations/314528"
],
"mime_type": "application/pdf",
"creator": "https://example.rossum.app/api/v1/users/1",
"created_at": "2020-05-21T12:34:56.789Z",
"arrived_at": "2020-05-21T12:34:56.789Z",
"original_file_name": "invoice.pdf",
"content": "https://example.rossum.app/api/v1/documents/314628/content",
"attachment_status": "processed",
"metadata": {
"some_key": "some_value"
}
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.