First-request guide for List Subscriptions.
List Subscriptions
List Subscriptions
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.
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/data/b2b/v1/subscriptions?subscriptionType=company%2CcompanyNews&page=1&perPage=10 \
--header "Authorization: Bearer $DB_API_KEY" \
--header "Accept: application/json"Read the response
{
"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
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
subscriptionType | query | string | Optional | Comma-separated list of subscription types to filter the results. Valid values include: company, companyNews, dbPerson, companyFamilyTree. |
page | query | integer | Optional | Page number for pagination. Default is 1. |
perPage | query | integer | Optional | Number 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
GETwith 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.
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
subscriptionType | query | string | Optional | Comma-separated list of subscription types to filter the results. Valid values include: company, companyNews, dbPerson, companyFamilyTree. |
page | query | integer | Optional | Page number for pagination. Default is 1. |
perPage | query | integer | Optional | Number of results per page. Default is 10, maximum is 50. |
Errors
Handle non-success responses explicitly so your integration can report actionable failures.
| Status | Meaning |
|---|---|
400 | Results per page value is invalid. |