Get all companies

GET /companies/v2/companies/paged

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Used to get all of the companies in a portal. Returns a paginated list of companies.

In addition to the list of companies, each request will also return two values, offset and has-more. If has-more is true, you'll need to make another request, using the offset to get the next page of company records.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.

Optional Parameters How to use Description
Limit limit=
Used in the request URL
The number of records to return. Defaults to 100, has a maximum value of 250.
Offset offset=
Used in the request URL
Used to page through the results. If there are more records in your portal than the limit= parameter, you will need to use the offset returned in the first request to get the next set of results.
Properties properties=
Used in the request URL, may be included multiple times.
Used to include specific company properties in the results.  By default, the results will only include the company ID, and will not include the values for any properties for your companies.  Including this parameter will include the data for the specified property in the results.  You can include this parameter multiple times to request multiple properties.
Note: Companies that do not have a value set for a property will not include that property, even when you specify the property. A company without a value for the website property would not show the website property in the results, even with &properties=website in the URL.
Properties with History propertiesWithHistory=
Used in the request URL, may be included multiple times.
Works similarly to properties=, but this parameter will include the history for the specified property, instead of just including the current value. Use this parameter when you need the full history of changes to a property's value.