Skip to navigation
Companies

List companies

Authentication

X-Schematic-Api-Keystring
API Key authentication via header

Query parameters

cancel_at_period_endbooleanOptional

If true, filter companies with an active subscription that is set to cancel at the end of the current period; if false, filter companies without one

credit_type_idslist of stringsOptional

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

has_scheduled_downgradebooleanOptional

If true, filter companies that have a pending scheduled downgrade; if false, filter companies that do not

idslist of stringsOptional

Filter companies by multiple company IDs (starts with comp_)

monetized_subscriptionsbooleanOptional
Filter companies that have monetized subscriptions
plan_idstringOptional

Filter companies by plan ID (starts with plan_)

plan_idslist of stringsOptional

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

plan_version_idstringOptional

Filter companies by plan version ID (starts with plvr_)

plan_version_idslist of stringsOptional

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

plan_version_unpublishedbooleanOptional
Filter companies assigned to a plan version that is no longer published, meaning the plan has since moved on to a newer version
qstringOptional<=512 characters
Search for companies by name, keys or string traits
sort_order_columnstringOptional<=255 characters

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

sort_order_directionenumOptional

Direction to sort by (asc or desc)

Allowed values:
subscription_statuseslist of enumsOptional
Filter companies by one or more subscription statuses
subscription_typeslist of enumsOptional
Filter companies by one or more subscription types
Allowed values:
with_entitlement_forstringOptional

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

without_feature_override_forstringOptional
Filter out companies that have an unexpired company override for the specified feature ID
without_planbooleanOptional
Filter out companies that have a plan
without_subscriptionbooleanOptional
Filter out companies that have a subscription
with_subscriptionbooleanOptional
Filter companies that have a subscription
limitlongOptional0-250

Page limit (default 100)

offsetlongOptional

Page offset (default 0)

Response

OK
datalist of objects
paramsobject
Input parameters

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error