List all contacts

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

GET /contacts

List all contacts

cURL

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

200

{
  "contacts": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Eve",
      "email": "[e-mail]",
      "phone_number": "",
      "created_at": "2025-03-15T10:30:00.000Z",
      "updated_at": "2025-03-15T10:30:00.000Z",
      "owner": null,
      "tags": [],
      "company": {
        "id": null,
        "name": null
      }
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Oliver",
      "email": "[e-mail]",
      "phone_number": "[phone]",
      "created_at": "2025-03-14T14:22:00.000Z",
      "updated_at": "2025-03-14T14:22:00.000Z",
      "owner": null,
      "tags": [],
      "company": {
        "id": null,
        "name": null
      }
    }
  ],
  "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 contacts.

contacts · object[]

List of contacts.

Hide child attributes

contacts. id · string

Unique identifier for the contact.

contacts. name · string

Name of the contact.

contacts. email · string | null

Email address of the contact.

contacts. phone_number · string | null

Phone number of the contact.

contacts. company_id · string | null

Unique identifier of the associated company.

contacts. organization_id · string

Unique identifier of the organization.

contacts. tag_ids · string[]

IDs of tags associated with the contact.

contacts. owner · object

Owner of the contact.

Hide child attributes

contacts.owner. id · string

Unique identifier of the owner.

contacts.owner. name · string

Name of the owner.

contacts.owner. email · string

Email of the owner.

contacts. company · object

Associated company.

Hide child attributes

contacts.company. id · string

Unique identifier of the company.

contacts.company. name · string

Name of the company.

contacts. field_values · object[]

Custom field values associated with the contact.

Hide child attributes

contacts.field_values. id · string

Unique identifier of the field value.

contacts.field_values. field_id · string

Unique identifier of the custom field.

contacts.field_values. value · string

Value of the custom field.

contacts. created_at · string<date-time>

Timestamp when the contact was created.

contacts. updated_at · string<date-time>

Timestamp when the contact 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.