Skip to main content

List companies

List companies

Query Parameters
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

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

createdAt date-time

Creation date of the segment

updatedAt date-time

Last update date of the segment