Demandbase

Demandbase Subscription API

Subscription creation, updates, status, alerts, and lifecycle operations.

Documentation GitHub OpenAPI

Operations 10

PUT /subscriptions/job Update an Existing Subscription #

POST /subscriptions/job Create a New Subscription #

GET /subscriptions/{subscriptionId}/entityIds Get Subscription Entity IDs #

GET /subscriptions/{subscriptionId}/alerts/{alertId} Retrieve a Specific Subscription Alert #

GET /subscriptions/{subscriptionId}/alerts List Subscription Alerts #

GET /subscriptions/{subscriptionId} Retrieve Subscription Details #

DELETE /subscriptions/{subscriptionId} Delete a Subscription #

GET /subscriptions/jobs List Subscription Jobs #

GET /subscriptions/job/{jobId} Check Subscription Job Status #

GET /subscriptions List Subscriptions #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/demandbase-subscription-api-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '1.0'
  title: B2B Subscription API
  description: 'The B2B API provides access to endpoints for searching, retrieving, and matching company and contact data.


    It includes support for:

    - **Company records:** Firmographic details, news, technologies, and more.

    - **Contact records:** Current role, employment history, and professional details.

    - **Demandbase Person profiles:** Persistent identities tied to individuals across multiple roles or companies.

    - **Subscriptions:** Monitoring updates to companies and DB Person records.

    ## Authentication

    All requests to the B2B API must be authenticated using a valid API token. If authentication fails, the API will respond with a `401 Unauthorized` status code.

    ### Obtaining an API Token

    For instructions on generating API tokens, see the [Generate and Manage API Key Set](https://support.demandbase.com/hc/en-us/articles/38999526296603-Generate-and-Manage-API-Key-Set) article at the Demandbase Help Center.

    ### Authorization Header

    Include your API token in the `Authorization` header of each request using the Bearer token scheme. Also set the `Content-Type` header to `application/json` when sending JSON payloads.

    #### Example

    ```

    Authorization: Bearer YOUR_API_KEY_HERE

    Content-Type: application/json

    ```


    > **Note:** Tokens should be treated as sensitive credentials. Do not expose them in public code repositories or client-side applications.'
  contact:
    name: Support
    url: https://www.demandbase.com/
    email: support@demandbase.com
servers:
- url: https://uapi.demandbase.com/data/b2b/v1
  description: Server URL in Production environment
security:
- bearerAuth: []
tags:
- name: Subscription API
  description: Subscription creation, updates, status, alerts, and lifecycle operations.
paths:
  /subscriptions/job:
    put:
      tags:
      - Subscription API
      summary: Update an Existing Subscription
      description: 'Use this API to update an existing subscription. You must provide both the subscriptionId and subscriptionType to identify which subscription you want to modify. This endpoint supports partial and full updates, including:


        - Replacing all associated entity IDs with the subscription (e.g., company IDs or dbPerson IDs).

        - Incrementally adding or removing entity IDs in the subscription.

        - Updating other subscription details such as frequency, webhook URL, signing secret, fields, or news categories.


        The API responds with a jobId, which can be used to check the job''s status. Once the job completes successfully, the subscription is updated accordingly.

        '
      operationId: updateSubscription
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriptionJobRequestDTO'
            examples:
              UpdateCompanySubscriptionRequest:
                description: UpdateCompanySubscriptionRequest
                value:
                  subscriptionId: 2aac4dd2-d2c9-485e-b9ef-388c63e54915
                  companyIds:
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  name: Updated Company Subscription
                  description: This is an updated subscription for company updates
                  subscriptionType: company
                  frequency: 14d
                  fields:
                  - all
                  webhook: http://www.your-domain.com/webhook-updated
                  signingSecret: updated-secret-key
              UpdateCompanyNewsSubscriptionRequest:
                description: UpdateCompanyNewsSubscriptionRequest
                value:
                  subscriptionId: 2aac4dd2-d2c9-485e-b9ef-388c63e54916
                  addCompanyIds:
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  removeCompanyIds:
                  - 6
                  - 7
                  name: Updated Company News Subscription
                  description: This is an updated subscription for company news updates
                  subscriptionType: companyNews
                  frequency: 60M
                  newsCategories:
                  - LEADERSHIP_CHANGES
                  - RESEARCH_DEVELOPMENT
                  - REALESTATE_DEALS
                  webhook: http://www.your-domain.com/webhook-updated
                  signingSecret: updated-secret-key
              UpdateCompanyFamilyTreeSubscriptionRequest:
                description: UpdateCompanyFamilyTreeSubscriptionRequest
                value:
                  subscriptionId: 2aac4dd2-d2c9-485e-b9ef-388c63e54917
                  addCompanyIds:
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  removeCompanyIds:
                  - 6
                  - 7
                  name: Updated Company FamilyTree Subscription
                  description: This is an updated subscription for company family tree updates
                  subscriptionType: companyFamilyTree
                  frequency: 1w
                  webhook: http://www.your-domain.com/webhook-updated
                  signingSecret: updated-secret-key
              UpdateDbPersonSubscriptionRequest:
                description: UpdateDbPersonSubscriptionRequest
                value:
                  subscriptionId: 2aac4dd2-d2c9-485e-b9ef-388c63e54918
                  addDBPersonIds:
                  - 101
                  - 102
                  - 103
                  - 104
                  - 105
                  removeDBPersonIds:
                  - 106
                  - 107
                  name: Updated DB Person Subscription
                  description: This is an updated subscription for dbPerson updates
                  subscriptionType: dbPerson
                  frequency: 14d
                  fields:
                  - all
                  webhook: http://www.your-domain.com/webhook-updated
                  signingSecret: updated-secret-key
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionJobResponseDTO'
              examples:
                SuccessResponse:
                  description: SuccessResponse
                  value:
                    jobId: 39ddf756-c04e-465c-b8c1-8d2c2be0abed
                    jobStatus: accepted
                    totalEntitiesProcessed: 0
                    jobType: notificationSubscriptionCreate
                    subscriptionType: company
                    createdAt: '2025-06-25T09:00:42.620Z'
            application/xml:
              schema:
                $ref: '#/components/schemas/SubscriptionJobResponseDTO'
              examples:
                SuccessResponseXml:
                  description: SuccessResponseXml
                  value:
                    jobId: 39ddf756-c04e-465c-b8c1-8d2c2be0abed
                    jobStatus: accepted
                    totalEntitiesProcessed: 0
                    jobType: notificationSubscriptionCreate
                    subscriptionType: company
                    createdAt: '2025-06-25T09:00:42.620Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidUrlResponse:
                  description: InvalidUrlResponse
                  value:
                    errorCode: 400-144
                    errorMessage: Invalid Webhook. Url syntax is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidSigningSecretResponse:
                  description: InvalidSigningSecretResponse
                  value:
                    errorCode: 400-145
                    errorMessage: Invalid Webhook. Signing secret is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidSubscriptionTypeResponse:
                  description: InvalidSubscriptionTypeResponse
                  value:
                    errorCode: 400-146
                    errorMessage: Invalid Subscription Type. Subscription type is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidStartTimeResponse:
                  description: InvalidStartTimeResponse
                  value:
                    errorCode: 400-147
                    errorMessage: Start time is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidFrequencyResponse:
                  description: InvalidFrequencyResponse
                  value:
                    errorCode: 400-149
                    errorMessage: Frequency has invalid pattern.
                    diagnosticCode: cceddfa1-90be-4a37-9b85-896223844f04
                InvalidFrequencyValueResponse:
                  description: InvalidFrequencyValueResponse
                  value:
                    errorCode: 400-150
                    errorMessage: Frequency value is invalid.
                    diagnosticCode: cceddfa1-90be-4a37-9b85-896223844f04
                InvalidFrequencyTypeResponse:
                  description: InvalidFrequencyTypeResponse
                  value:
                    errorCode: 400-151
                    errorMessage: Frequency type is invalid.
                    diagnosticCode: e8bb70af-ab52-4bb3-a2cb-538801fc9ed4
                InvalidFieldResponse:
                  description: InvalidFieldResponse
                  value:
                    errorCode: 400-157
                    errorMessage: One or more fields is invalid for provided subscription type.
                    diagnosticCode: dd1546d9-f8c3-4b86-bcec-8acbae92998b
                InvalidAgentResponse:
                  description: InvalidAgentResponse
                  value:
                    errorCode: 400-163
                    errorMessage: One or more news category is invalid for provided subscription type.
                    diagnosticCode: cafba766-624e-40b7-8952-4acb657ada09
                EmptyCompanyIdsResponse:
                  description: EmptyCompanyIdsResponse
                  value:
                    errorCode: 400-158
                    errorMessage: At least one company ID must be provided.
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                EmptyContactIdsResponse:
                  description: EmptyContactIdsResponse
                  value:
                    errorCode: 400-159
                    errorMessage: At least one contact ID must be provided.
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                CompanyIdsLimitExceededResponse:
                  description: CompanyIdsLimitExceededResponse
                  value:
                    errorCode: 400-160
                    errorMessage: Company ids exceeds the permissible limit for subscription job
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                ContactIdsLimitExceededResponse:
                  description: ContactIdsLimitExceededResponse
                  value:
                    errorCode: 400-161
                    errorMessage: Contact ids exceeds the permissible limit for subscription job
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidUrlResponseXml:
                  description: InvalidUrlResponseXml
                  value:
                    errorCode: 400-144
                    errorMessage: Invalid Webhook. Url syntax is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidSigningSecretResponseXml:
                  description: InvalidSigningSecretResponseXml
                  value:
                    errorCode: 400-145
                    errorMessage: Invalid Webhook. Signing secret is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidSubscriptionTypeResponseXml:
                  description: InvalidSubscriptionTypeResponseXml
                  value:
                    errorCode: 400-146
                    errorMessage: Invalid Subscription Type. Subscription type is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidStartTimeResponseXml:
                  description: InvalidStartTimeResponseXml
                  value:
                    errorCode: 400-147
                    errorMessage: Start time is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidFrequencyResponseXml:
                  description: InvalidFrequencyResponseXml
                  value:
                    errorCode: 400-149
                    errorMessage: Frequency has invalid pattern.
                    diagnosticCode: cceddfa1-90be-4a37-9b85-896223844f04
                InvalidFrequencyValueResponseXml:
                  description: InvalidFrequencyValueResponseXml
                  value:
                    errorCode: 400-150
                    errorMessage: Frequency value is invalid.
                    diagnosticCode: cceddfa1-90be-4a37-9b85-896223844f04
                InvalidFrequencyTypeResponseXml:
                  description: InvalidFrequencyTypeResponseXml
                  value:
                    errorCode: 400-151
                    errorMessage: Frequency type is invalid.
                    diagnosticCode: e8bb70af-ab52-4bb3-a2cb-538801fc9ed4
                InvalidFieldResponseXml:
                  description: InvalidFieldResponseXml
                  value:
                    errorCode: 400-157
                    errorMessage: One or more fields is invalid for provided subscription type.
                    diagnosticCode: dd1546d9-f8c3-4b86-bcec-8acbae92998b
                EmptyCompanyIdsResponseXml:
                  description: EmptyCompanyIdsResponseXml
                  value:
                    errorCode: 400-158
                    errorMessage: At least one company ID must be provided.
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                EmptyContactIdsResponseXml:
                  description: EmptyContactIdsResponseXml
                  value:
                    errorCode: 400-159
                    errorMessage: At least one contact ID must be provided.
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                CompanyIdsLimitExceededResponseXml:
                  description: CompanyIdsLimitExceededResponseXml
                  value:
                    errorCode: 400-160
                    errorMessage: Company ids exceeds the permissible limit for subscription job
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                ContactIdsLimitExceededResponseXml:
                  description: ContactIdsLimitExceededResponseXml
                  value:
                    errorCode: 400-161
                    errorMessage: Contact ids exceeds the permissible limit for subscription job
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
        '401':
          description: Unauthorized because the user is not authenticated.
          content:
            application/json:
              examples:
                UnauthorizedResponse:
                  description: UnauthorizedResponse
                  value:
                    status: Authentication Failed - Unauthorized.
      security:
      - bearerAuth: []
      servers:
      - url: https://uapi.demandbase.com/data/b2b/v1
        description: Server URL in Production environment
    post:
      tags:
      - Subscription API
      summary: Create a New Subscription
      description: 'Use this endpoint to create a subscription for monitoring updates to companies or DB Person records. Subscriptions allow you to receive change alerts via webhook and access historical alerts via API.


        Each subscription is processed asynchronously. A jobId is returned on submission. Upon completion, the job will return a subscriptionId which can be used to fetch alerts or manage the subscription.'
      operationId: updateSubscription_1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionJobRequestDTO'
            examples:
              Company Subscription Request Example:
                description: Company Subscription Request Example
                value:
                  companyIds:
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  name: Company Subscription
                  description: This is a subscription for company updates
                  subscriptionType: company
                  startDate: '2025-06-25'
                  frequency: 7d
                  fields:
                  - all
                  webhook: http://www.your-domain.com/webhook
                  signingSecret: secret-key
              Company News Subscription Request Example:
                description: Company News Subscription Request Example
                value:
                  companyIds:
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  name: Company News Subscription
                  description: This is a subscription for company news updates
                  subscriptionType: companyNews
                  startDate: '2025-06-25'
                  frequency: 30M
                  newsCategories:
                  - LEADERSHIP_CHANGES
                  - RESEARCH_DEVELOPMENT
                  - REALESTATE_DEALS
                  webhook: http://www.your-domain.com/webhook
                  signingSecret: secret-key
              Company Family Tree Subscription Request Example:
                description: Company Family Tree Subscription Request Example
                value:
                  companyIds:
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  name: Company FamilyTree Subscription
                  description: This is a subscription for company family tree updates
                  subscriptionType: companyFamilyTree
                  startDate: '2025-06-25'
                  frequency: 2w
                  webhook: http://www.your-domain.com/webhook
                  signingSecret: secret-key
              DbPerson Subscription Request Example:
                description: DbPerson Subscription Request Example
                value:
                  dbPersonIds:
                  - 101
                  - 102
                  - 103
                  - 104
                  - 105
                  name: DB Person Subscription
                  description: This is a subscription for dbPerson updates
                  subscriptionType: dbPerson
                  startDate: '2025-06-25'
                  frequency: 7d
                  fields:
                  - all
                  webhook: http://www.your-domain.com/webhook
                  signingSecret: secret-key
      responses:
        '202':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionJobResponseDTO'
              examples:
                SuccessResponse:
                  description: SuccessResponse
                  value:
                    jobId: 39ddf756-c04e-465c-b8c1-8d2c2be0abed
                    jobStatus: accepted
                    totalEntitiesProcessed: 0
                    jobType: notificationSubscriptionCreate
                    subscriptionType: company
                    createdAt: '2025-06-25T09:00:42.620Z'
            application/xml:
              schema:
                $ref: '#/components/schemas/SubscriptionJobResponseDTO'
              examples:
                SuccessResponseXml:
                  description: SuccessResponseXml
                  value:
                    jobId: 39ddf756-c04e-465c-b8c1-8d2c2be0abed
                    jobStatus: accepted
                    totalEntitiesProcessed: 0
                    jobType: notificationSubscriptionCreate
                    subscriptionType: company
                    createdAt: '2025-06-25T09:00:42.620Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidUrlResponse:
                  description: InvalidUrlResponse
                  value:
                    errorCode: 400-144
                    errorMessage: Invalid Webhook. Url syntax is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidSigningSecretResponse:
                  description: InvalidSigningSecretResponse
                  value:
                    errorCode: 400-145
                    errorMessage: Invalid Webhook. Signing secret is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidSubscriptionTypeResponse:
                  description: InvalidSubscriptionTypeResponse
                  value:
                    errorCode: 400-146
                    errorMessage: Invalid Subscription Type. Subscription type is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidStartTimeResponse:
                  description: InvalidStartTimeResponse
                  value:
                    errorCode: 400-147
                    errorMessage: Start time is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidFrequencyResponse:
                  description: InvalidFrequencyResponse
                  value:
                    errorCode: 400-149
                    errorMessage: Frequency has invalid pattern.
                    diagnosticCode: cceddfa1-90be-4a37-9b85-896223844f04
                InvalidFrequencyValueResponse:
                  description: InvalidFrequencyValueResponse
                  value:
                    errorCode: 400-150
                    errorMessage: Frequency value is invalid.
                    diagnosticCode: cceddfa1-90be-4a37-9b85-896223844f04
                InvalidFrequencyTypeResponse:
                  description: InvalidFrequencyTypeResponse
                  value:
                    errorCode: 400-151
                    errorMessage: Frequency type is invalid.
                    diagnosticCode: e8bb70af-ab52-4bb3-a2cb-538801fc9ed4
                InvalidFieldResponse:
                  description: InvalidFieldResponse
                  value:
                    errorCode: 400-157
                    errorMessage: One or more fields is invalid for provided subscription type.
                    diagnosticCode: dd1546d9-f8c3-4b86-bcec-8acbae92998b
                InvalidAgentResponse:
                  description: InvalidAgentResponse
                  value:
                    errorCode: 400-163
                    errorMessage: One or more news category is invalid for provided subscription type.
                    diagnosticCode: cafba766-624e-40b7-8952-4acb657ada09
                EmptyCompanyIdsResponse:
                  description: EmptyCompanyIdsResponse
                  value:
                    errorCode: 400-158
                    errorMessage: At least one company ID must be provided.
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                EmptyContactIdsResponse:
                  description: EmptyContactIdsResponse
                  value:
                    errorCode: 400-159
                    errorMessage: At least one contact ID must be provided.
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                CompanyIdsLimitExceededResponse:
                  description: CompanyIdsLimitExceededResponse
                  value:
                    errorCode: 400-160
                    errorMessage: Company ids exceeds the permissible limit for subscription job
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                ContactIdsLimitExceededResponse:
                  description: ContactIdsLimitExceededResponse
                  value:
                    errorCode: 400-161
                    errorMessage: Contact ids exceeds the permissible limit for subscription job
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InvalidUrlResponseXml:
                  description: InvalidUrlResponseXml
                  value:
                    errorCode: 400-144
                    errorMessage: Invalid Webhook. Url syntax is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidSigningSecretResponseXml:
                  description: InvalidSigningSecretResponseXml
                  value:
                    errorCode: 400-145
                    errorMessage: Invalid Webhook. Signing secret is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidSubscriptionTypeResponseXml:
                  description: InvalidSubscriptionTypeResponseXml
                  value:
                    errorCode: 400-146
                    errorMessage: Invalid Subscription Type. Subscription type is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidStartTimeResponseXml:
                  description: InvalidStartTimeResponseXml
                  value:
                    errorCode: 400-147
                    errorMessage: Start time is invalid.
                    diagnosticCode: 261d677a-a60e-4a2c-81a7-b55a0ae148c0
                InvalidFrequencyResponseXml:
                  description: InvalidFrequencyResponseXml
                  value:
                    errorCode: 400-149
                    errorMessage: Frequency has invalid pattern.
                    diagnosticCode: cceddfa1-90be-4a37-9b85-896223844f04
                InvalidFrequencyValueResponseXml:
                  description: InvalidFrequencyValueResponseXml
                  value:
                    errorCode: 400-150
                    errorMessage: Frequency value is invalid.
                    diagnosticCode: cceddfa1-90be-4a37-9b85-896223844f04
                InvalidFrequencyTypeResponseXml:
                  description: InvalidFrequencyTypeResponseXml
                  value:
                    errorCode: 400-151
                    errorMessage: Frequency type is invalid.
                    diagnosticCode: e8bb70af-ab52-4bb3-a2cb-538801fc9ed4
                InvalidFieldResponseXml:
                  description: InvalidFieldResponseXml
                  value:
                    errorCode: 400-157
                    errorMessage: One or more fields is invalid for provided subscription type.
                    diagnosticCode: dd1546d9-f8c3-4b86-bcec-8acbae92998b
                EmptyCompanyIdsResponseXml:
                  description: EmptyCompanyIdsResponseXml
                  value:
                    errorCode: 400-158
                    errorMessage: At least one company ID must be provided.
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                EmptyContactIdsResponseXml:
                  description: EmptyContactIdsResponseXml
                  value:
                    errorCode: 400-159
                    errorMessage: At least one contact ID must be provided.
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                CompanyIdsLimitExceededResponseXml:
                  description: CompanyIdsLimitExceededResponseXml
                  value:
                    errorCode: 400-160
                    errorMessage: Company ids exceeds the permissible limit for subscription job
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
                ContactIdsLimitExceededResponseXml:
                  description: ContactIdsLimitExceededResponseXml
                  value:
                    errorCode: 400-161
                    errorMessage: Contact ids exceeds the permissible limit for subscription job
                    diagnosticCode: a5631e82-0dfc-41ea-9ce8-8089ceff022f
        '401':
          description: Unauthorized because the user is not authenticated.
          content:
            application/json:
              examples:
                UnauthorizedResponse:
                  description: UnauthorizedResponse
                  value:
                    status: Authentication Failed - Unauthorized.
      security:
      - bearerAuth: []
      servers:
      - url: https://uapi.demandbase.com/data/b2b/v1
        description: Server URL in Production environment
  /subscriptions/{subscriptionId}/entityIds:
    get:
      tags:
      - Subscription API
      summary: Get Subscription Entity IDs
      description: '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.

        '
      operationId: getSubscriptionEntityDetails
      parameters:
      - name: page
        in: query
        description: Page number for pagination. Default is 1.
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          example: 1
      - name: perPage
        in: query
        description: Number of results per page. Default is 5000, maximum is 5000.
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 5000
          default: 5000
          example: 10
      - name: subscriptionId
        in: path
        description: Unique identifier for the subscription
        required: true
        schema:
          type: string
          example: 287ea0c8-99de-4f0c-addc-097f78b48ba6
      responses:
        '200':
          description: Entity ID list retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionEntityDetailsDTO'
              examples:
                Company IDs - JSON:
                  description: Company IDs - JSON
                  value:
                    companyIds:
                    - '643462'
                    - '1042601'
                    - '643223'
                    - '642023'
                    - '26176'
                    - '643886'
                    - '848207'
                    - '741359'
                    - '643768'
                    - '642647'
                    pageNo: 1
                    totalCount: 10
                    pageSize: 50
                    totalPages: 1
                DB Person IDs - JSON:
                  description: DB Person IDs - JSON
                  value:
                    dbPersonIds:
                    - '643462'
                    - '1042601'
                    - '643223'
                    - '642023'
                    - '26176'
                    - '643886'
                    - '848207'
                    - '741359'
                    - '643768'
                    - '642647'
                    pageNo: 1
                    totalCount: 10
                    pageSize: 50
                    totalPages: 1
            application/xml:
      

# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/demandbase/refs/heads/main/openapi/demandbase-subscription-api-api-openapi.yml