Sign in

v1

latestOpenAPI 3.1.02026-07-17220542.8 KB
Submissions

Get a submission

The API endpoint provides the functionality to retrieve information about a submission.

get/submissions/{id}

Path parameters

idinteger required

The unique identifier of the submission.

Response

OK

idinteger required

Submission unique ID number.

namestring

Name of the document submission.

slugstring required

Unique slug of the submission.

source'invite' | 'bulk' | 'api' | 'embed' | 'link' required

The source of the submission.

submitters_order'random' | 'preserved' required

The order of submitters.

audit_log_urlstring nullable required

Audit log file URL.

combined_document_urlstring nullable required

Combined PDF file URL with documents and Audit Log.

created_atstring required

The date and time when the submission was created.

updated_atstring required

The date and time when the submission was last updated.

archived_atstring nullable required

The date and time when the submission was archived.

status'completed' | 'declined' | 'expired' | 'pending' required

The status of the submission.

metadataobject required

Object with custom metadata.

completed_atstring nullable required

The date and time when the submission was completed.

Example response

{
  "name": "Test Submission Document"
}