List all companies

You can list companies.

     

Request Path Parameters
Parameter Type Required Description
org_id number Yes The unique identifier of your organization
page number No
limit number No The number of items returned in a single response
Default is 10

 

Response

This will return a paginated list of Company objects.

 

Example Request & Response


$ curl https://api.custerem.com/<org_id>/companies/ \
-X GET \
-H 'Authorization: X-API-KEY <Your API Key>' \
-H 'Content-Type: application/json' \

 


$ curl https://api.custerem.com/<org_id>/companies/?page=1&limit=2 \
-X GET \
-H 'Authorization: X-API-KEY <Your API Key>' \
-H 'Content-Type: application/json' \

 

200 OK

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 30,
            "company_industry": "Cloud CRM",
            "contacts": [],
            "number_of_employees": null,
            "annual_revenue": null,
            "company_name": "Custerem",
            "phone_number": "+46000",
            "city": "Helsingborg",
            "state": "Skåne",
            "postal_code": "11111",
            "description": "Simple, fast and powerful cloud CRM",
            "linked_in_company_page": "https://linkedin.com/"
        },
        {
            "id": 28,
            "company_industry": "Cloud CRM",
            "contacts": [
                {
                    "id": 5,
                    "name": "Hayri Cicek"
                }
            ],
            "number_of_employees": null,
            "annual_revenue": null,
            "company_name": "Custerem",
            "phone_number": "12343",
            "city": "city",
            "state": "state",
            "postal_code": "12232",
            "description": "description",
            "linked_in_company_page": "https://"
        }
    ]
}