v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Companies

Get all companies

get/companies

Query parameters

filtersstring

Filter by attrbutes. If you have filter for owner on your side please send it as {"attributes.owner":"5b1a17d914b73d35a76ca0c7"}

linkedContactsIdsinteger

Filter by linked contacts ids

linkedDealsIdsstring objectID

Filter by linked deals ids

pageinteger

Index of the first document of the page

limitinteger

Number of documents per page

sort'asc' | 'desc'

Sort the results in the ascending/descending order. Default order is descending by creation if sort is not passed

sortBystring

The field used to sort field names.

Response

Returns companies list with filters

Example response

{
  "items": [
    {
      "linkedDealsIds": [
        "61a5ce58c5d4795761045990",
        "61a5ce58c5d4795761045991",
        "61a5ce58c5d4795761045992"
      ],
      "linkedContactsIds": [
        1,
        2,
        3
      ],
      "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
      },
      "id": "629475917295261d9b1f4403"
    },
    {
      "linkedDealsIds": [
        "61a5ce58c5d4795761045990",
        "61a5ce58c5d4795761045991",
        "61a5ce58c5d4795761045992"
      ],
      "linkedContactsIds": [
        1,
        2,
        3
      ],
      "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
      },
      "id": "629475917295261d9b1f4403"
    }
  ]
}