Skip to main content
GET
/
campaigns
/
v2
/
{campaignId}
/
import-jobs
List import jobs
curl --request GET \
  --url https://inboxapp.com/api/v1/campaigns/v2/{campaignId}/import-jobs \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "totalCount": 1500,
      "processedCount": 0,
      "addedCount": 0,
      "skippedCount": 0,
      "failedCount": 0,
      "error": "Rate limit exceeded",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2025-01-16T08:00:00.000Z",
      "completedAt": "2025-01-16T08:05:00.000Z"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
campaignId
string
required

The ID of the campaign.

Pattern: ^[0-9a-z]+$

Query Parameters

​
status
enum<string>[]

Filter by one or more job statuses. Omit to return jobs in all statuses.

Available options:
queued,
starting,
running,
paused,
completed,
failed,
canceled
Example:
["running", "queued"]
​
cursor
string

Pagination cursor. Omit to start from the beginning.

​
limit
integer
default:50

Maximum number of import jobs to return per page. Defaults to 50, maximum 100.

Required range: 1 <= x <= 100
Example:

50

Response

200 - application/json

OK

​
data
object[]
required
​
nextCursor
string | null
required

Cursor to fetch the next page. Null if there are no more results.