---
title: "Get company reports"
method: GET
path: "/api/v2/reports/company_reports"
tags: ["Reports"]
---

# Get company reports

`GET /api/v2/reports/company_reports`

Retrieve aggregated company report data grouped by configurable dimensions.

## Query parameters

- `filter` union — Filter schema for `company_report` list endpoints — pass a single condition or a logical group.
  - object — A logical filter group — combine multiple conditions with the `$op` operator.
    - `$op` 'or' | 'and', required — Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match.
  - FilterCompanyReport — Available filter parameters for querying aggregated company report data.
    - `name` union — Filter company report results by name.
      - Name — unresolved $ref
      - object — Filter operator object for name.
        - `not_eq` Name — unresolved $ref
        - `eq` Name — unresolved $ref
        - `contains` Name — unresolved $ref
        - `not_contain` Name — unresolved $ref
    - `exclude_company_and_children` union — Filter by excluding a company and all its subsidiaries from results.
      - ExcludeCompanyAndChildren — unresolved $ref
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `contains` ExcludeCompanyAndChildren — unresolved $ref
        - `eq` ExcludeCompanyAndChildren — unresolved $ref
        - `not_eq` ExcludeCompanyAndChildren — unresolved $ref
        - `not_contain` ExcludeCompanyAndChildren — unresolved $ref
    - `fuzzy_people` union — Filter company report results by fuzzy people.
      - FuzzyPeople — unresolved $ref
      - object — Filter operator object for fuzzy people.
        - `not_eq` FuzzyPeople — unresolved $ref
        - `eq` FuzzyPeople — unresolved $ref
        - `contains` FuzzyPeople — unresolved $ref
        - `not_contain` FuzzyPeople — unresolved $ref
    - `parent_company_id` union — Filter by the parent company of the company.
      - ParentCompanyId — unresolved $ref
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `eq` ParentCompanyId — unresolved $ref
        - `not_contain` ParentCompanyId — unresolved $ref
        - `not_eq` ParentCompanyId — unresolved $ref
        - `contains` ParentCompanyId — unresolved $ref
    - `subsidiary_id` union — Filter company report results by subsidiary id.
      - SubsidiaryId — unresolved $ref
      - object — Filter operator object for subsidiary id.
        - `not_contain` SubsidiaryId — unresolved $ref
        - `eq` SubsidiaryId — unresolved $ref
        - `not_eq` SubsidiaryId — unresolved $ref
        - `contains` SubsidiaryId — unresolved $ref
    - `payment_terms` union — Filter company report results by payment terms.
      - object — Filter operator object for payment terms.
        - `eq` PaymentTerms — unresolved $ref
        - `contains` PaymentTerms — unresolved $ref
        - `not_contain` PaymentTerms — unresolved $ref
        - `not_eq` PaymentTerms — unresolved $ref
      - PaymentTerms — unresolved $ref
    - `project_id` union — Filter company report results by project id.
      - ProjectId — unresolved $ref
      - object — Filter operator object for project id.
        - `not_eq` ProjectId — unresolved $ref
        - `eq` ProjectId — unresolved $ref
        - `contains` ProjectId — unresolved $ref
        - `not_contain` ProjectId — unresolved $ref
    - `default_tax_rate_id` union — Filter company report results by default tax rate id.
      - object — Filter operator object for default tax rate id.
        - `contains` DefaultTaxRateId — unresolved $ref
        - `eq` DefaultTaxRateId — unresolved $ref
        - `not_eq` DefaultTaxRateId — unresolved $ref
        - `not_contain` DefaultTaxRateId — unresolved $ref
      - DefaultTaxRateId — unresolved $ref
    - `company_id` union — Filter by client company.
      - CompanyId — unresolved $ref
      - object — Filter operators for company_id using ID matching conditions.
        - `not_eq` CompanyId — unresolved $ref
        - `not_contain` CompanyId — unresolved $ref
        - `eq` CompanyId — unresolved $ref
        - `contains` CompanyId — unresolved $ref
    - `default_subsidiary_id` union — Filter company report results by default subsidiary id.
      - DefaultSubsidiaryId — unresolved $ref
      - object — Filter operator object for default subsidiary id.
        - `contains` DefaultSubsidiaryId — unresolved $ref
        - `not_eq` DefaultSubsidiaryId — unresolved $ref
        - `eq` DefaultSubsidiaryId — unresolved $ref
        - `not_contain` DefaultSubsidiaryId — unresolved $ref
    - `subscriber_id` union — Filter company report results by subscriber id.
      - SubscriberId — unresolved $ref
      - object — Filter operator object for subscriber id.
        - `eq` SubscriberId — unresolved $ref
        - `not_eq` SubscriberId — unresolved $ref
        - `contains` SubscriberId — unresolved $ref
        - `not_contain` SubscriberId — unresolved $ref
    - `fuzzy_dates` union — Filter company report results by fuzzy dates.
      - FuzzyDates — unresolved $ref
      - object — Filter operator object for fuzzy dates.
        - `eq` FuzzyDates — unresolved $ref
        - `contains` FuzzyDates — unresolved $ref
        - `not_eq` FuzzyDates — unresolved $ref
        - `not_contain` FuzzyDates — unresolved $ref
    - `query` union — Filter company report results by query.
      - object — Filter operator object for query.
        - `eq` Query — unresolved $ref
        - `not_contain` Query — unresolved $ref
        - `contains` Query — unresolved $ref
        - `not_eq` Query — unresolved $ref
      - Query — unresolved $ref
    - `custom_fields` union — Filter by custom field values.
      - CustomFields — unresolved $ref
      - object — Filter operators for custom_fields using string matching conditions.
        - `eq` CustomFields — unresolved $ref
        - `not_contain` CustomFields — unresolved $ref
        - `contains` CustomFields — unresolved $ref
        - `not_eq` CustomFields — unresolved $ref
    - `jump_query` union — Filter company report results by jump query.
      - JumpQuery — unresolved $ref
      - object — Filter operator object for jump query.
        - `not_eq` JumpQuery — unresolved $ref
        - `contains` JumpQuery — unresolved $ref
        - `not_contain` JumpQuery — unresolved $ref
        - `eq` JumpQuery — unresolved $ref
    - `last_activity_at` union — Filter by last activity date range (`last_activity_at`).
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `not_eq` LastActivityAt — unresolved $ref
        - `eq` LastActivityAt — unresolved $ref
        - `not_contain` LastActivityAt — unresolved $ref
        - `contains` LastActivityAt — unresolved $ref
      - LastActivityAt — unresolved $ref
    - `tags` union — Filter by tag.
      - object — Filter operators for tags using string matching conditions.
        - `not_contain` Tags — unresolved $ref
        - `not_eq` Tags — unresolved $ref
        - `contains` Tags — unresolved $ref
        - `eq` Tags — unresolved $ref
      - Tags — unresolved $ref
    - `status` union — Filter company report results by status.
      - Status — unresolved $ref
      - object — Filter operator object for status.
        - `contains` Status — unresolved $ref
        - `not_eq` Status — unresolved $ref
        - `eq` Status — unresolved $ref
        - `not_contain` Status — unresolved $ref
    - `billing_name` union — Filter by the company's full billing name.
      - BillingName — unresolved $ref
      - object — Filter operators for billing_name using string matching conditions.
        - `not_eq` BillingName — unresolved $ref
        - `eq` BillingName — unresolved $ref
        - `contains` BillingName — unresolved $ref
        - `not_contain` BillingName — unresolved $ref
    - `archived_at` union — Filter by archive date range (`archived_at`).
      - object — Filter operators for archived_at using date matching conditions.
        - `eq` ArchivedAt — unresolved $ref
        - `not_contain` ArchivedAt — unresolved $ref
        - `not_eq` ArchivedAt — unresolved $ref
        - `contains` ArchivedAt — unresolved $ref
      - ArchivedAt — unresolved $ref
    - `default_currency` union — Filter company report results by default currency.
      - object — Filter operator object for default currency.
        - `not_contain` DefaultCurrency — unresolved $ref
        - `eq` DefaultCurrency — unresolved $ref
        - `not_eq` DefaultCurrency — unresolved $ref
        - `contains` DefaultCurrency — unresolved $ref
      - DefaultCurrency — unresolved $ref
    - `id` union — Filter company report results by id.
      - object — Filter operator object for id.
        - `not_eq` Id — unresolved $ref
        - `contains` Id — unresolved $ref
        - `eq` Id — unresolved $ref
        - `not_contain` Id — unresolved $ref
      - Id — unresolved $ref
    - `due_days` union — Filter company report results by due days.
      - object — Filter operator object for due days.
        - `eq` DueDays — unresolved $ref
        - `not_contain` DueDays — unresolved $ref
        - `contains` DueDays — unresolved $ref
        - `not_eq` DueDays — unresolved $ref
      - DueDays — unresolved $ref
    - `created_at` union — Filter by creation date range (`created_at`).
      - CreatedAt — unresolved $ref
      - object — Filter operators for created_at using date matching conditions.
        - `contains` CreatedAt — unresolved $ref
        - `eq` CreatedAt — unresolved $ref
        - `not_contain` CreatedAt — unresolved $ref
        - `not_eq` CreatedAt — unresolved $ref
    - `vat` union — Filter company report results by vat.
      - object — Filter operator object for vat.
        - `not_eq` Vat — unresolved $ref
        - `contains` Vat — unresolved $ref
        - `eq` Vat — unresolved $ref
        - `not_contain` Vat — unresolved $ref
      - Vat — unresolved $ref
    - `full_query` union — Filter company report results by full query.
      - object — Filter operator object for full query.
        - `contains` FullQuery — unresolved $ref
        - `eq` FullQuery — unresolved $ref
        - `not_contain` FullQuery — unresolved $ref
        - `not_eq` FullQuery — unresolved $ref
      - FullQuery — unresolved $ref
    - `has_parent_company` union — Filter by whether the company has a parent company assigned.
      - HasParentCompany — unresolved $ref
      - object — Operator object — supports eq, not_eq, contains, not_contain.
        - `contains` HasParentCompany — unresolved $ref
        - `eq` HasParentCompany — unresolved $ref
        - `not_contain` HasParentCompany — unresolved $ref
        - `not_eq` HasParentCompany — unresolved $ref
    - `company_code` union — Filter by the company's unique company code.
      - object — Filter operators for company_code using string matching conditions.
        - `not_eq` CompanyCode — unresolved $ref
        - `not_contain` CompanyCode — unresolved $ref
        - `contains` CompanyCode — unresolved $ref
        - `eq` CompanyCode — unresolved $ref
      - CompanyCode — unresolved $ref
- `sort` string[]
- `group` 'company' | 'contact_address' | 'contact_city' | 'contact_country' | 'contact_email' | 'contact_phone' | 'contact_state' | 'contact_website' | 'contact_zipcode' | 'created_at' | 'custom_fields' | 'last_activity_at' | 'month' | 'organization' | 'parent_company' | 'quarter' | 'status' | 'subsidiary' | 'week' | 'year'

## Headers

- `X-Organization-Id` string, required

## Response `200`

Collection company report

---

[API](https://skmtc.dev/productive/apis/api-documentation.md) · [All operations](https://skmtc.dev/productive/apis/api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/productive/api-documentation/revisions/bbf5057edf0d/schema)