v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Companies list

The method allows you to get a list of companies

get/api/v4/companies

withstring

This parameter takes a string that may consist of several values separated by commas. See the table above.

pageinteger

Page of response

limitinteger

The number of the entities returned in the response to one request (limit – 250)

querystring

Search query (will perform a search by custom fields values)

order[updated_at]'asc' | 'desc'

List elements sorting by the time companies were updated at

order[id]'asc' | 'desc'

List elements sorting by companies IDs

filter[id][]integer[]

Filter by company ID

filter[name][]string[]

Filter by company name

filter[created_by][]integer[]

Filter by ID of the user who added the company.

filter[updated_by][]integer[]

Filter by ID of the user who updated the company last

filter[responsible_user_id][]integer[]

Filter by ID of the company responsible user

filter[created_at][from]integer

Filter by the creation date of the company in Unix Timestamp format. As a response you will get all the companies added after the date.

filter[created_at][to]integer

Filter by the creation date of the company in Unix Timestamp format. As a response you will get all the companies added before the date.

filter[updated_at][from]integer

Filter by date in Unix Timestamp format when the company was updated. As a response you will get all the companies updated after the date.

filter[updated_at][to]integer

Filter by date in Unix Timestamp format when the company was updated. As a response you will get all the companies updated before the date.

filter[closest_task_at][from]integer

Filter leads by the date of the task closest to completion in Unix Timestamp format.

filter[closest_task_at][to]integer

Filter leads by the date of the task closest to completion in Unix Timestamp format.

200