First-request guide for Jobs list.
Overview
Returns a list of import jobs. This provides an overview of all historical and current data import activities within the Demandbase platform.
Quickstart
Follow these two steps to make a request and recognize a successful response.
Make a request
curl --request GET \
--url https://uapi.demandbase.com/import/v1/jobs \
--header "Authorization: Bearer $DB_API_KEY" \
--header "Accept: application/json"Read the response
{
"totalCount": 0,
"data": [
{
"id": 67849,
"dataImportName": "EMEA accounts import",
"entityType": "Account",
"state": "processing",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T17:12:29Z"
}
]
}Request anatomy
Build the request from the method, path, parameters, and payload described below.
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
entityType | query | string | Optional | One of 'Account', 'Opportunity', 'Person' or 'Activity', case insensitive |
state | query | string | Optional | One of 'new', 'processing', 'completed', 'failed' |
sort | query | string | Optional | |
page | query | integer (int32) | Optional | |
perPage | query | integer (int32) | Optional |
Request body
This endpoint does not define a JSON request body.
Response anatomy
The endpoint returns 200 for the documented success case. The response is a JSON object containing a total count and an array of job objects. Each job object in the array contains the full metadata for a specific data import job.
The response schema does not enumerate fields; inspect the example response and status code.
Rules
- Use
GETwith the path/jobs. - Required inputs: No parameters are marked required in the published schema..
- Authenticate every request with a valid Demandbase access token.
- This endpoint does not require a JSON request body.
Filters
The published schema exposes the following endpoint inputs. Use the location column to place each value correctly.
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
entityType | query | string | Optional | One of 'Account', 'Opportunity', 'Person' or 'Activity', case insensitive |
state | query | string | Optional | One of 'new', 'processing', 'completed', 'failed' |
sort | query | string | Optional | |
page | query | integer (int32) | Optional | |
perPage | query | integer (int32) | Optional |
Errors
Handle non-success responses explicitly so your integration can report actionable failures.
| Status | Meaning |
|---|---|
400 | Bad Request Error |
401 | Returned if the authentication credentials are missing or invalid. |
403 | Returned if the authenticated user lacks the "Import Data" permission |
500 | Internal Server Error |