Collections
Export collection
Collections
Export collection
Exports the specified Collection. This will run as a background job.
POST
/
v2
/
collections
/
{Id}
/
export
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
id
integer
requiredThe ID of the collection to export.
Response
200 - application/json
id
string
The ID of the job.
outputDocuments
object[]
The documents that were created by this job.
queuedAt
string
The date and time that the job was queued for processing.
status
enum<string>
The status of the job. Possible values:
queued- The job has been queued and is waiting to be processed.`processing- The job is being processed.`done- The job has completed successfully.error- The job has completed with errors.
Available options:
queued, processing, done, error summary
string
Summary description of the job.
type
string
The type of job