Overview

Retrieve all entity IDs (company or dbPerson) associated with a given subscription. The response is paginated and depends on the type of subscription: - For "company" or "companyFamilyTree" subscriptions, it returns Company IDs. - For "dbPerson" subscriptions, it returns Demandbase Person IDs.

Quickstart

Follow these two steps to make a request and recognize a successful response.

curl --request GET \
  --url https://uapi.demandbase.com/data/b2b/v1/subscriptions/287ea0c8-99de-4f0c-addc-097f78b48ba6/entityIds?page=1&perPage=10 \
  --header "Authorization: Bearer $DB_API_KEY" \
  --header "Accept: application/json"

{
  "companyIds": [
    "643462",
    "1042601",
    "643223",
    "642023",
    "26176",
    "643886",
    "848207",
    "741359",
    "643768",
    "642647"
  ],
  "pageNo": 1,
  "totalCount": 10,
  "pageSize": 50,
  "totalPages": 1
}

Request anatomy

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

Parameters

Request body

This endpoint does not define a JSON request body.

Response anatomy

The endpoint returns 200 for the documented success case. Entity ID list retrieved successfully.

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

Rules

• Use GET with the path /subscriptions/{subscriptionId}/entityIds.
• 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.

Errors

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

Next steps

Back to top