List companies

List companies

Query Parameters
per_page number Possible values: value ≤ 100 Number of items to return per page (max 100)
offset number Number of items to skip (for pagination)
created_before date-time Filter items created before this date (ISO 8601 format)
created_after date-time Filter items created after this date (ISO 8601 format)
updated_before date-time Filter items updated before this date (ISO 8601 format)
updated_after date-time Filter items updated after this date (ISO 8601 format)
externalUid string Filter companies by external unique identifier

Responses

200 Return a paginated list of companies Schema — OPTIONAL companies object[] Array of companies id string Unique identifier of the company clientId string Client identifier name string Name of the company description string — OPTIONAL Description of the company domains string[] Domains associated with the company createdAt date-time Creation date of the company updatedAt date-time Last update date of the company importId string — OPTIONAL Only defined when the company was created from XLSX import, equal to its defined ID externalUid string — OPTIONAL Only defined when external uid has been setup in Harvestr and when the entity has an external uid in source segments object[] Segments associated with this company id string Unique identifier of the segment clientId string Client identifier name string Name of the segment dynamicType string Possible values: [MANUAL, DYNAMIC] How the segment's membership is decided. MANUAL segments are assigned, and are the only ones this API can attach a contributor to. A DYNAMIC segment's membership is computed from its rule, so a name resolving to one is ignored on write and the segment still appears here when the contributor matches it. createdAt date-time Creation date of the segment updatedAt date-time Last update date of the segment