API GUIDE

List Subscription Jobs

GET/subscriptions/jobsNo request bodyAuthentication required

ON THIS PAGE

Quickstart Request anatomy Response anatomy Rules Filters Errors Next steps

Overview

Retrieve a paginated list of all subscription jobs created by your tenant. Results are returned in descending order by creation time (`createdAt`). You can apply filters based on time period, date range, job status, and job type. Period can be specified as `day`, `month`, or `year`. If `day` is selected, you can specify a range of days (e.g., 2024-09-01 to 2024-09-07). For `month`, you can specify a range of months (e.g., 2024-09 to 2024-10). For `year`, you can specify a range of years (e.g., 2024 to 2025 for the entire year).

Call the endpoint

Send a GET request to /subscriptions/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/data/b2b/v1/subscriptions/jobs?period=month&start=2024-09&end=2024-10&jobStatus=processing&jobType=notificationSubscriptionCreate&page=2&perPage=25 \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"

STEP 2

Read the response

SUCCESS RESPONSE · HTTP 200

{
  "subscriptionJobs": [
    {
      "jobId": "39ddf756-c04e-465c-b8c1-8d2c2be0abed",
      "subscriptionId": "63914a27-a5ca-4fdf-80b0-ffc985f53c14",
      "jobType": "notificationSubscriptionCreate",
      "jobStatus": "accepted",
      "createdAt": "2025-02-02T16:44:47.295360Z"
    },
    {
      "jobId": "blpabc9bgs2273jnufj5-4e2b-4c2a-9b1a-1a2b3c4d5e6f",
      "subscriptionId": "u572ptlm8hugfbmeiqh6-7c8d-4e2b-9b1a-1a2b3c4d5e6f",
      "jobType": "notificationSubscriptionCreate",
      "jobStatus": "finished",
      "createdAt": "2025-03-19T06:11:41.899058Z"
    },
    {
      "jobId": "fsg6131mstfi0fkvsfeq-8f7e-4d2b-9b1a-1a2b3c4d5e6f",
      "subscriptionId": "n39mbqc1nplo6nevgjj8-9a8b-4c2a-9b1a-1a2b3c4d5e6f",
      "jobType": "notificationSubscriptionUpdate",
      "jobStatus": "finished",
      "createdAt": "2025-03-19T06:13:12.787300Z"
    }
  ],
  "pageNo": 1,
  "pageSize": 10,
  "totalCount": 879
}

Request anatomy

Build the request from the method, path, parameters, and payload described below.

Parameters

Name	Location	Type	Required	Description
`period`	query	string	Optional	The time period type you want to filter jobs by. Valid values: - day - month - year
`start`	query	string	Optional	Start day/month/year(inclusive) for the selected period. Start format depends on the period type: - day: YYYY-MM-DD (e.g., 2024-09-01) - month: YYYY-MM (e.g.,…
`end`	query	string	Optional	End day/month/year(inclusive) for the selected period. End format depends on the period type: - day: YYYY-MM-DD (e.g., 2024-09-30) - month: YYYY-MM (e.g., 2024…
`jobStatus`	query	string	Optional	Filter jobs by their status. Valid values: - failed - accepted - processing - finished
`jobType`	query	string	Optional	Type of subscription job to filter by. Valid values: - notificationSubscriptionCreate - notificationSubscriptionUpdate
`page`	query	string	Optional	Page number to retrieve. Must be 1 or higher.
`perPage`	query	string	Optional	Number of results per page (max 50).

Request body

This endpoint does not define a JSON request body.

Response anatomy

The endpoint returns 200 for the documented success case. List of subscription jobs returned successfully.

The response schema does not enumerate fields; inspect the example response and status code.

Rules

Use GET with the path /subscriptions/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
`period`	query	string	Optional	The time period type you want to filter jobs by. Valid values: - day - month - year
`start`	query	string	Optional	Start day/month/year(inclusive) for the selected period. Start format depends on the period type: - day: YYYY-MM-DD (e.g., 2024-09-01) - month: YYYY-MM (e.g.,…
`end`	query	string	Optional	End day/month/year(inclusive) for the selected period. End format depends on the period type: - day: YYYY-MM-DD (e.g., 2024-09-30) - month: YYYY-MM (e.g., 2024…
`jobStatus`	query	string	Optional	Filter jobs by their status. Valid values: - failed - accepted - processing - finished
`jobType`	query	string	Optional	Type of subscription job to filter by. Valid values: - notificationSubscriptionCreate - notificationSubscriptionUpdate
`page`	query	string	Optional	Page number to retrieve. Must be 1 or higher.
`perPage`	query	string	Optional	Number of results per page (max 50).

Errors

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

Status	Meaning
`400`	Invalid input or unsupported query parameters.
`401`	Authentication is required or token is invalid.

Next steps

Technical specification

View the full endpoint specification

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 subscription-api