Jobs list — Guide

First-request guide for Jobs list.

API GUIDE

Jobs list

Jobs list

GET/jobsNo request bodyAuthentication required

Overview

Returns a list of import jobs. This provides an overview of all historical and current data import activities within the Demandbase platform.

Call the endpoint

Send a GET request to /jobs with the required authentication and parameters.

Supply endpoint parameters

Review the parameter table to see which path, query, or header values the endpoint accepts.

Inspect the response

Use the success response shape to validate the fields your integration receives.

Quickstart

Follow these two steps to make a request and recognize a successful response.

STEP 1

Make a request

REQUEST
curl --request GET \
  --url https://uapi.demandbase.com/import/v1/jobs \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"
STEP 2

Read the response

SUCCESS RESPONSE · HTTP 200
{
  "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

NameLocationTypeRequiredDescription
entityTypequerystringOptionalOne of 'Account', 'Opportunity', 'Person' or 'Activity', case insensitive
statequerystringOptionalOne of 'new', 'processing', 'completed', 'failed'
sortquerystringOptional
pagequeryinteger (int32)Optional
perPagequeryinteger (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 GET with 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.

NameLocationTypeRequiredDescription
entityTypequerystringOptionalOne of 'Account', 'Opportunity', 'Person' or 'Activity', case insensitive
statequerystringOptionalOne of 'new', 'processing', 'completed', 'failed'
sortquerystringOptional
pagequeryinteger (int32)Optional
perPagequeryinteger (int32)Optional

Errors

Handle non-success responses explicitly so your integration can report actionable failures.

StatusMeaning
400Bad Request Error
401Returned if the authentication credentials are missing or invalid.
403Returned if the authenticated user lacks the "Import Data" permission
500Internal Server Error

Next steps

Try the quickstart

Start with the request example, then replace the sample values with your credentials and data.

Return to the API area

Back to import-job

Back to top