Retrieve Subscription Details — Guide

First-request guide for Retrieve Subscription Details.

API GUIDE

Retrieve Subscription Details

Retrieve Subscription Details

GET/subscriptions/{subscriptionId}No request bodyAuthentication required

Overview

Fetch detailed information for a specific subscription using its subscription ID. The response includes: - Subscription type (e.g., company, dbPerson, companyNews, companyFamilyTree) - Frequency and start date - Next scheduled notification time - Webhook configuration details (if applicable) - Tracked fields or subscribed news categories, depending on the subscription type

Call the endpoint

Send a GET request to /subscriptions/{subscriptionId} 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/287ea0c8-99de-4f0c-addc-097f78b48ba6 \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"
STEP 2

Read the response

SUCCESS RESPONSE · HTTP 200
{
  "startDate": "2025-06-25",
  "createdAt": "2025-06-25T09:02:56.994Z",
  "frequency": "2d",
  "fields": [
    "revenue",
    "phone",
    "websites",
    "name"
  ],
  "webhook": {
    "url": "http://www.your-domain.com/webhook",
    "status": "VERIFICATION_RUNNING",
    "signingSecret": "secret-key"
  },
  "subscriptionType": "company",
  "name": "testSubscription",
  "description": "Testing Bulk Jobs",
  "nextFireTime": "2025-05-22T00:00:00.000Z"
}

Request anatomy

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

Parameters

NameLocationTypeRequiredDescription
subscriptionIdpathstringRequiredUnique identifier for the subscription

Request body

This endpoint does not define a JSON request body.

Response anatomy

The endpoint returns 200 for the documented success case. Subscription details retrieved successfully.

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

Rules

  • Use GET with the path /subscriptions/{subscriptionId}.
  • Required inputs: subscriptionId.
  • 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
subscriptionIdpathstringRequiredUnique identifier for the subscription

Errors

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

StatusMeaning
400The subscription exists but is not accessible by the current user.
401Unauthorized. The request lacks valid authentication credentials.
404The subscription ID was not found.

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