Data Types


Lists the most recently issued background jobs.

Requires a secret_* API key.

GET /v2/accounts/{accountId}/jobs
1curl "{accountId}/jobs?jobType=CopyFileBatchJob" \
2 -H "Authorization: Bearer YOUR_API_KEY"
Response (200)
2 "items": [
3 {
4 "accountId": "YOUR_ACCOUNT_ID",
5 "attempts": 2,
6 "created": 1615680311115,
7 "error": {
8 "code": "error_code",
9 "message": "Error message."
10 },
11 "jobId": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
12 "jobType": "DeleteFileBatchJob",
13 "lastUpdated": 1615680311115,
14 "status": "Cancelled",
15 "summary": {
16 "deletions": [
17 "/file/to/delete.jpg"
18 ]
19 }
20 }
21 ]

Response Body

URL Parameters


Your account ID.

This is visible on the settings page:

Example: A623uY2

Type: String

Length: 7

In: Path

Required: Yes


Job type.

This parameter can be set multiple times.

Type: String

Allowed Values: CopyFileBatchJob, CopyFolderBatchJob, DeleteFileBatchJob, DeleteFolderBatchJob

In: Querystring

Required: Yes

Request Headers


Add one of these Authorization header values to your request:

Option 1: prefix "Bearer " to your API key. The result is your Authorization header value.

Option 2: use HTTP basic authorization, specifying apikey as your username, and your API key as your password.

Note: this endpoint requires a secret_* API key.

Type: String

In: Header

Required: Yes

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: