v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
Company

Retrieves the collection of Company resources.

Retrieves the collection of Company resources.

get/companies

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Company collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier for the company

namestring

Company name

isActiveboolean nullable

A boolean indicating whether the company is active or not

urlstring nullable

The web address of the company

Example response

[
  {
    "integration": "quickbooks"
  }
]