v1

latestOpenAPI 3.0.3Proprietary2026-07-244065126.5 KB

Data Warehouse

Bulk Add Data Warehouse Company Subscriptions

Add subscriptions to multiple companies for the authenticated user. This operation respects the user's subscription limit and syncs the local database. If the user has Snowflake and/or Databricks permissions, subscriptions are also synced to the corresponding data warehouses. If the number of requested companies exceeds the user's remaining subscription slots, only the first N companies that fit within the limit will be processed; the rest will be returned in 'skipped_limit_exceeded'.

post/api/v2/companies/bulk-subscribe

Request body

company_idsinteger[] required

Response

insertedinteger[]

Company IDs successfully subscribed across all warehouses.

already_existedinteger[]

Company IDs that already had an entitlement in a data warehouse.

not_foundinteger[]

Company IDs that do not exist in the data warehouse.

skipped_already_subscribedinteger[]

Company IDs already subscribed locally before calling the data warehouse.

skipped_limit_exceededinteger[]

Company IDs excluded because the subscription limit would be exceeded.

warehousesobject

Per-warehouse breakdown of results.

Example response

{
  "inserted": [
    101,
    102
  ],
  "already_existed": [
    103
  ],
  "not_found": [
    999
  ],
  "skipped_already_subscribed": [
    104
  ],
  "skipped_limit_exceeded": [
    105,
    106
  ],
  "warehouses": {
    "snowflake": {
      "inserted": [
        101,
        102
      ],
      "already_existed": [
        103
      ],
      "not_found": [
        999
      ],
      "error": null
    },
    "databricks": {
      "inserted": [
        101
      ],
      "already_existed": [
        102,
        103
      ],
      "not_found": [
        999
      ],
      "error": null
    }
  }
}