API GUIDE

Retrieve a Specific Subscription Alert

GET/subscriptions/{subscriptionId}/alerts/{alertId}No request bodyAuthentication required

ON THIS PAGE

Quickstart Request anatomy Response anatomy Rules Filters Errors Next steps

Overview

Retrieve detailed alert updates for a specific subscription using its subscription ID and alert ID. Use `List Subscription Alerts` API to fetch latest alerts. This endpoint returns the specific fields or news categories that triggered the alert, depending on the type of subscription: - **company**: Returns a list of company IDs and the fields that changed (e.g., name, address). - **companynews**: Returns company IDs and related news articles with timestamps. - **companyfamilytree**: - Identifies companies added to or removed from the family tree. - Includes migration messages if the root company itself was acquired. - **dbPerson**: Returns p…

Call the endpoint

Send a GET request to /subscriptions/{subscriptionId}/alerts/{alertId} 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/example/alerts/example?page=1&perPage=10 \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"

STEP 2

Read the response

SUCCESS RESPONSE · HTTP 200

{
  "companyAlertDetails": [
    {
      "companyId": "6265",
      "fields": [
        "employees"
      ]
    },
    {
      "companyId": "677586",
      "fields": [
        "employees"
      ]
    },
    {
      "companyId": "724368",
      "fields": [
        "companyStatusV2",
        "revenue",
        "businessStructure",
        "companyStatus",
        "employees"
      ]
    },
    {
      "companyId": "751147",
      "fields": [
        "employees"
      ]
    },
    {
      "companyId": "25321",
      "fields": [
        "employees"
      ]
    },
    {
      "companyId": "15191",
      "fields": [
        "employees"
      ]
    },
    {
      "companyId": "712000",
      "fields": [
        "employees"
      ]
    },
    {
      "companyId": "966735",
      "fields": [
        "employees"
      ]
    },
    {
      "companyId": "2992705",
      "fields": [
        "companyStatusV2",
        "revenue",
        "businessStructure",
        "companyStatus"
      ]
    },
    {
      "companyId": "966833",
      "fields": [
        "employees"
      ]
    },
    {
      "companyId": "51212245",
      "fields": [
        "address",
        "businessStructure",
        "employeeRange",
        "companyStatus",
        "employees"
      ]
    },
    {
      "companyId": "1040416",
      "fields": [
        "employees"
      ]
    }
  ],
  "subscriptionType": "company",
  "pageNo": 1,
  "pageSize": 100,
  "totalCount": 12,
  "totalPages": 1
}

Request anatomy

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

Parameters

Name	Location	Type	Required	Description
`page`	query	integer	Optional	Page number for pagination. Default is 1.
`perPage`	query	integer	Optional	Number of results per page. Default is 5000, maximum is 5000.
`subscriptionId`	path	string	Required	Unique identifier for the subscription
`alertId`	path	string	Required	Unique identifier for the alert

Request body

This endpoint does not define a JSON request body.

Response anatomy

The endpoint returns 200 for the documented success case. Alert 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}/alerts/{alertId}.
Required inputs: subscriptionId, alertId.
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
`page`	query	integer	Optional	Page number for pagination. Default is 1.
`perPage`	query	integer	Optional	Number of results per page. Default is 5000, maximum is 5000.
`subscriptionId`	path	string	Required	Unique identifier for the subscription
`alertId`	path	string	Required	Unique identifier for the alert

Errors

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

Status	Meaning
`401`	Unauthorized. Authentication credentials are missing or invalid.
`404`	The subscription or alert ID was not found.

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