Sign in
Company

List all existing companies

get/v1/companies

Query parameters

Idinteger
DepartmentIdinteger
Namestring
Emailstring
Phonestring
Example:12124567890

Phone number with country code, without leading + (plus) sign, minimum 4 digits or empty. Items having a phone number that starts with the given value will be returned.

Addressstring
Statestring
Citystring
Townstring
Webstring
CountryCodestring
FromCreatedDatestring
ToCreatedDatestring
CustomFieldsobject
Qstring
Fieldsstring
DepartmentScopeDepartmentPageSelection

Selects departments for a page-level query. The query-string value can be all or a comma-separated list of positive department IDs, such as 12,34.

Selects departments for a page-level query. The query-string value can be all or a comma-separated list of positive department IDs, such as 12,34.

ViewType0 | 1
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul><p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
Pageinteger
ItemsPerPageinteger
ReturnTotalItemsboolean
sortColstring
sortDirstring
isExportboolean

Response

OK

totalItemsinteger

Example response

{
  "items": [
    {
      "name": "Acme Inc",
      "email": "info@acmeinc.com",
      "phone": "12124567890",
      "web": "acmeinc.com",
      "countryCode": "US"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.