companies

List companies

Changed on
get/companies

Request

  • Base URL
    https://api.schematichq.com
  • URL
    https://api.schematichq.com/companies
  • Auth
    API key in header X-Schematic-Api-Key

Query parameters

credit_type_idsstring[]

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

idsstring[]

Filter companies by multiple company IDs (starts with comp_)

monetized_subscriptionsboolean

Filter companies that have monetized subscriptions

plan_idstring

Filter companies by plan ID (starts with plan_)

plan_idsstring[]

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_)

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.

plan_version_unpublishedboolean

Filter companies assigned to a plan version that is no longer published, meaning the plan has since moved on to a newer version

qstring

Search for companies by name, keys or string traits

sort_order_columnstring

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

subscription_typesSubscriptionType[]

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

without_feature_override_forstring

Filter out companies that have an unexpired company override for the specified feature ID

without_planboolean

Filter out companies that have a plan

without_subscriptionboolean

Filter out companies that have a subscription

with_subscriptionboolean

Filter companies that have a subscription

limitinteger

Page limit (default 100)

offsetinteger

Page offset (default 0)

Response

OK

Changes

  • 6d4b96940aadRevision changes
    • info

      added the optional property //// to the response with the status

  • ce7c5cc627adRevision changes
    • warning

      added the new end_date_must_be_future enum value to the ////// response property for the response status

    • warning

      added the new end_date_needs_new_subscription enum value to the ////// response property for the response status

    • warning

      added the new end_date_not_after_renewal_date enum value to the ////// response property for the response status