POST
/
v2
/
collections
/
{Id}
/
export
curl --request POST \
  --url https://api.usecloudpress.com/v2/collections/{Id}/export \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "outputDocuments": [
    {
      "links": [
        {
          "description": "<string>",
          "title": "<string>",
          "url": "<string>"
        }
      ],
      "title": "<string>"
    }
  ],
  "queuedAt": "2023-11-07T05:31:56Z",
  "status": "queued",
  "summary": "<string>",
  "type": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
integer
required

The ID of the collection to export.

Response

200
application/json
Success
​
id
string

The ID of the job.

​
outputDocuments
object[]

The documents that were created by this job.

Represents an document that was created as result of a 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

Get ConnectionList Collections