List Subscriptions — Guide

First-request guide for List Subscriptions.

API GUIDE

List Subscriptions

List Subscriptions

GET/subscriptionsNo request bodyAuthentication required

Overview

Retrieve a list of all subscriptions associated with your tenant. You can filter results by one or more subscription types and paginate through the results. Results are returned in pages, with support for customizing the number of items per page.

Call the endpoint

Send a GET request to /subscriptions 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?subscriptionType=company%2CcompanyNews&page=1&perPage=10 \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"
STEP 2

Read the response

SUCCESS RESPONSE · HTTP 200
{
  "subscriptions": [
    {
      "name": "Subscription Name",
      "description": "Subscription Description",
      "subscriptionType": "company",
      "subscriptionId": "12345"
    }
  ],
  "pageNo": 1,
  "pageSize": 10,
  "totalCount": 1
}

Request anatomy

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

Parameters

NameLocationTypeRequiredDescription
subscriptionTypequerystringOptionalComma-separated list of subscription types to filter the results. Valid values include: company, companyNews, dbPerson, companyFamilyTree.
pagequeryintegerOptionalPage number for pagination. Default is 1.
perPagequeryintegerOptionalNumber of results per page. Default is 10, maximum is 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 subscriptions retrieved successfully.

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

Rules

  • Use GET with the path /subscriptions.
  • 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
subscriptionTypequerystringOptionalComma-separated list of subscription types to filter the results. Valid values include: company, companyNews, dbPerson, companyFamilyTree.
pagequeryintegerOptionalPage number for pagination. Default is 1.
perPagequeryintegerOptionalNumber of results per page. Default is 10, maximum is 50.

Errors

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

StatusMeaning
400Results per page value is invalid.

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

Back to top