companies | RevVue | Developer Docs

query ExampleQuery($queryOffset: Int, $queryLimit: Int, $activeState: ActiveState, $ids: [UUID], $countOnly: Boolean, $freeTextSearch: String, $filterOperator: LogicalOperator, $filters: [FilterConditionInput], $name: [String], $companyType: [CompanyType]) {
  companies(queryOffset: $queryOffset, queryLimit: $queryLimit, activeState: $activeState, ids: $ids, countOnly: $countOnly, freeTextSearch: $freeTextSearch, filterOperator: $filterOperator, filters: $filters, name: $name, companyType: $companyType) {
    documents {
      id
      documentType
      activeState
      created
      changed
      createdBy
      changedBy
      tenantId
      name
      companyType
    }
    count
  }
}

{
  "queryOffset": 0,
  "queryLimit": 0,
  "activeState": "ACTIVE",
  "ids": [
    "example"
  ],
  "countOnly": true,
  "freeTextSearch": "example",
  "filterOperator": "AND",
  "filters": [
    {
      "column": "example",
      "operator": "EQ",
      "value": "example",
      "jsonPath": "example"
    }
  ],
  "name": [
    "example"
  ],
  "companyType": [
    "QUICK_SERVICE"
  ]
}

{
  "data": {
    "companies": {
      "documents": [
        {
          "id": "example",
          "documentType": "ANALYTICS",
          "activeState": "ACTIVE",
          "created": "2026-09-18T23:20:08.822Z",
          "changed": "2026-09-18T23:20:08.822Z",
          "createdBy": "example",
          "changedBy": "example",
          "tenantId": "example",
          "name": "example",
          "companyType": [
            "QUICK_SERVICE"
          ]
        }
      ],
      "count": 0
    }
  }
}

Arguments

queryOffsetIntegerOptional

Limit search with start index.

queryLimitIntegerOptional

Limit search with stop index.

activeStateActiveStateOptional

Active state

Allowed values:

idslist of optional StringsOptional

Document ids.

countOnlyBooleanOptional

Return only count.

freeTextSearchStringOptional

Free text search.

filterOperatorLogicalOperatorOptional

Filter operator, e.g. 'and', 'or'.

Allowed values:

filterslist of optional FilterConditionInputOptional

List of filters to apply on the query.

namelist of optional StringsOptional

Company names.

companyTypelist of optional CompanyTypeOptional

Customer

Returns

an optional CompanyQuery

documentslist of optional CompanyOptional

countIntegerOptional

Query result count.