List all companies

Retrieve a list of all companies in your workspace. Results are ordered by creation date (newest first).

GET /companies

List all companies

cURL

curl --request GET \
  --url https://{your-subdomain}.neetocrm.com/api/external/v1/companies \
  --header 'X-Api-Key: <x-api-key>'

200

{
  "companies": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Eve Corp",
      "address": "123 Main St, New York, NY",
      "source": null,
      "tags": [],
      "created_at": "2025-03-15T10:30:00.000Z",
      "updated_at": "2025-03-15T10:30:00.000Z"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Oliver Industries",
      "address": "456 Oak Ave, San Francisco, CA",
      "source": null,
      "tags": [],
      "created_at": "2025-03-14T14:22:00.000Z",
      "updated_at": "2025-03-14T14:22:00.000Z"
    }
  ],
  "pagination": {
    "total_records": 42,
    "total_pages": 2,
    "current_page_number": 1,
    "page_size": 30
  }
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key · string · required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Query Parameters

page_number · integer

Retrieve paginated results by specifying the desired page number. If this parameter is absent, all results will be returned.

page_size · integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

Response

200 - application/json

Successfully retrieved companies.

companies · object[]

List of companies.

Hide child attributes

companies. id · string

Unique identifier for the company.

companies. name · string

Name of the company.

companies. address · string | null

Address of the company.

companies. source · string | null

Source of the company.

companies. tags · object[]

Tags associated with the company.

Hide child attributes

companies.tags. id · string

Unique identifier for the tag.

companies.tags. name · string

Name of the tag.

companies.tags. style · string

Style/color of the tag.

companies. created_at · string<date-time>

Timestamp when the company was created.

companies. updated_at · string<date-time>

Timestamp when the company was last updated.

pagination · object

Hide child attributes

pagination. total_records · integer

Total number of records.

pagination. total_pages · integer

Total number of pages available.

pagination. current_page_number · integer

Current page number.

pagination. page_size · integer

Number of records per page.