v80

OpenAPI 3.0.0raw.githubusercontent.com2026-08-03260491955.2 KB
companies

Count companies

get/companies/count

Query parameters

credit_type_idsstring[]

Filter companies by one or more credit type IDs (each ID starts with bcrd_)

Filter companies by one or more credit type IDs (each ID starts with bcrd_)

has_scheduled_downgradeboolean

Filter companies that have a pending scheduled downgrade

Filter companies that have a pending scheduled downgrade

idsstring[]

Filter companies by multiple company IDs (starts with comp_)

Filter companies by multiple company IDs (starts with comp_)

monetized_subscriptionsboolean

Filter companies that have monetized subscriptions

Filter companies that have monetized subscriptions

plan_idstring

Filter companies by plan ID (starts with plan_)

Filter companies by plan ID (starts with plan_)

plan_idsstring[]

Filter companies by one or more plan IDs (each ID starts with plan_)

Filter companies by one or more plan IDs (each ID starts with plan_)

plan_version_idstring

Filter companies by plan version ID (starts with plvr_)

Filter companies by plan version ID (starts with plvr_)

plan_version_idsstring[]

Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set.

Filter companies by one or more plan version IDs (each ID starts with plvr_). Takes precedence over plan_version_id when set.

qstring

Search for companies by name, keys or string traits

Search for companies by name, keys or string traits

sort_order_columnstring

Column to sort by (e.g. name, created_at, last_seen_at)

Column to sort by (e.g. name, created_at, last_seen_at)

sort_order_direction'asc' | 'desc'

Direction to sort by (asc or desc)

subscription_statusesSubscriptionStatus[]

Filter companies by one or more subscription statuses

Filter companies by one or more subscription statuses

subscription_typesSubscriptionType[]

Filter companies by one or more subscription types

Filter companies by one or more subscription types

with_entitlement_forstring

Filter companies that have an entitlement (plan entitlement or company override) for the specified feature ID

Filter companies that have an entitlement (plan entitlement or company override) for the specified feature ID

without_feature_override_forstring

Filter out companies that already have a company override for the specified feature ID

Filter out companies that already have a company override for the specified feature ID

without_planboolean

Filter out companies that have a plan

Filter out companies that have a plan

without_subscriptionboolean

Filter out companies that have a subscription

Filter out companies that have a subscription

with_subscriptionboolean

Filter companies that have a subscription

Filter companies that have a subscription

limitinteger

Page limit (default 100)

Page limit (default 100)

offsetinteger

Page offset (default 0)

Page offset (default 0)

Response

OK