Get all Companies
GET {{baseUrl}}/companies?filters=veniam elit in&linkedContactsIds=13396752&linkedDealsIds=veniam elit in&page=13396752&limit=13396752&sort=desc&sortBy=veniam elit in
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filters | string | Filter by attrbutes. If you have filter for owner on your side please send it as {"attributes.owner":"6299dcf3874a14eacbc65c46"} | |
linkedContactsIds | number | Filter by linked contacts ids | |
linkedDealsIds | string | Filter by linked Deals ids | |
page | number | Index of the first document of the page | |
limit | number | Number of documents per page | |
sort | string | Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed | |
sortBy | string | The field used to sort field names. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"629475917295261d9b1f4403","attributes":{"created_at":"2022-01-13T19:04:24.376+05:30","domain":"xyz","last_updated_at":"2022-04-01T18:47:48.283+05:30","name":"text","number_of_contacts":0,"owner":"62260474111b1101704a9d85","owner_assign_date":"2022-04-01T18:21:13.379+05:30","phone_number":8171844192,"revenue":10},"linkedContactsIds":[1,2,3],"linkedDealsIds":["61a5ce58c5d4795761045990","61a5ce58c5d4795761045991","61a5ce58c5d4795761045992"]},{"id":"629475917295261d9b1f4403","attributes":{"created_at":"2022-01-13T19:04:24.376+05:30","domain":"xyz","last_updated_at":"2022-04-01T18:47:48.283+05:30","name":"text","number_of_contacts":0,"owner":"62260474111b1101704a9d85","owner_assign_date":"2022-04-01T18:21:13.379+05:30","phone_number":8171844192,"revenue":10},"linkedContactsIds":[1,2,3],"linkedDealsIds":["61a5ce58c5d4795761045990","61a5ce58c5d4795761045991","61a5ce58c5d4795761045992"]}]}