GET /v2/companies
Return all the companies
live_help Notes
assignment
This action requires one of theses roles:
Companies manager
chrome_reader_mode
This resource is paginated by 30 items
settings Params
| Param name | Description |
|---|---|
| sort |
optional
. Must be one of: id, name, slug, sector, other_sector, size, phone, address, zip, city, country, website_url, owner_id, created_at, updated_at, latitude, longitude, siret, pro_id, owner_type, administrative_email.
The sort field. Sorted by created_at desc, id desc by default. MoreExample:To sort on companies on the fields owner_type on a descending order and administrative_email on a ascending order: ...&sort=-owner_type,administrative_email |
| filter |
optional
. Must be one of: id, name, slug, sector, other_sector, size, phone, address, zip, city, country, website_url, owner_id, created_at, updated_at, latitude, longitude, siret, pro_id, owner_type, administrative_email, offer_id, expertise_id.
Filtering on one or more fields MoreExample:
To filter on companies with the
...&filter[id]=a_value,another_value Filterable fields:
|
| page |
optional
. Must be a Hash
The pagination params, as a hash |
| page[number] |
optional
. Must be Fixnum
The current page |
| page[size] |
optional
. Must be Fixnum
The number of items per page, defaults to 30, maximum 100 |