Skip to main content

List companies

List companies

Query Parameters
externalUid string
per_page number REQUIRED

Possible values: value ≤ 100

offset number REQUIRED
created_before date-time
created_after date-time
updated_before date-time
updated_after date-time
Responses
200

Return a paginated list of companies

Schema OPTIONAL
companies object[]
id string
clientId string
name string
createdAt date-time

can be an empty string

updatedAt date-time
importId string OPTIONAL

only defined when the company were created from XLSL 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[]
id string
clientId string
name string
createdAt date-time
updatedAt date-time
pageInfos object
next_offset number
per_page number
code number
messageStatus string