# Create company
Source: https://apidocs.neetocrm.com/api-reference-v1/companies/create

bundled-v1/companies.yaml POST /companies
Create a new company in your workspace.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Delete company
Source: https://apidocs.neetocrm.com/api-reference-v1/companies/delete

bundled-v1/companies.yaml DELETE /companies/{id}
Delete a company by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Get company
Source: https://apidocs.neetocrm.com/api-reference-v1/companies/get

bundled-v1/companies.yaml GET /companies/{id}
Retrieve a single company by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# List companies
Source: https://apidocs.neetocrm.com/api-reference-v1/companies/list

bundled-v1/companies.yaml GET /companies
Retrieve a list of all companies in your workspace. Results are ordered by creation date (newest first).

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Update company
Source: https://apidocs.neetocrm.com/api-reference-v1/companies/update

bundled-v1/companies.yaml PATCH /companies/{id}
Update an existing company by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Create contact
Source: https://apidocs.neetocrm.com/api-reference-v1/contacts/create

bundled-v1/contacts.yaml POST /contacts
Create a new contact in your workspace.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Delete contact
Source: https://apidocs.neetocrm.com/api-reference-v1/contacts/delete

bundled-v1/contacts.yaml DELETE /contacts/{id}
Delete a contact by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Get contact
Source: https://apidocs.neetocrm.com/api-reference-v1/contacts/get

bundled-v1/contacts.yaml GET /contacts/{id}
Retrieve a single contact by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# List contacts
Source: https://apidocs.neetocrm.com/api-reference-v1/contacts/list

bundled-v1/contacts.yaml GET /contacts
Retrieve a list of all contacts in your workspace. Results are ordered by creation date (newest first).

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Update contact
Source: https://apidocs.neetocrm.com/api-reference-v1/contacts/update

bundled-v1/contacts.yaml PATCH /contacts/{id}
Update an existing contact by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Create deal
Source: https://apidocs.neetocrm.com/api-reference-v1/deals/create

bundled-v1/deals.yaml POST /deals
Create a new deal in your workspace.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Delete deal
Source: https://apidocs.neetocrm.com/api-reference-v1/deals/delete

bundled-v1/deals.yaml DELETE /deals/{id}
Delete a deal by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Get deal
Source: https://apidocs.neetocrm.com/api-reference-v1/deals/get

bundled-v1/deals.yaml GET /deals/{id}
Retrieve a single deal by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# List deals
Source: https://apidocs.neetocrm.com/api-reference-v1/deals/list

bundled-v1/deals.yaml GET /deals
Retrieve a list of all deals in your workspace. Results are ordered by creation date (newest first).

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Update deal
Source: https://apidocs.neetocrm.com/api-reference-v1/deals/update

bundled-v1/deals.yaml PATCH /deals/{id}
Update an existing deal by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Create lead
Source: https://apidocs.neetocrm.com/api-reference-v1/leads/create

bundled-v1/leads.yaml POST /leads
Create a new lead in your workspace.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Delete lead
Source: https://apidocs.neetocrm.com/api-reference-v1/leads/delete

bundled-v1/leads.yaml DELETE /leads/{id}
Delete a lead by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Get lead
Source: https://apidocs.neetocrm.com/api-reference-v1/leads/get

bundled-v1/leads.yaml GET /leads/{id}
Retrieve a single lead by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# List leads
Source: https://apidocs.neetocrm.com/api-reference-v1/leads/list

bundled-v1/leads.yaml GET /leads
Retrieve a list of all leads in your workspace. Results are ordered by creation date (newest first).

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Update lead
Source: https://apidocs.neetocrm.com/api-reference-v1/leads/update

bundled-v1/leads.yaml PATCH /leads/{id}
Update an existing lead by its ID.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Add team members
Source: https://apidocs.neetocrm.com/api-reference-v1/team-members/add

bundled-v1/team-members.yaml POST /team_members
Add team members to the workspace.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# List team members
Source: https://apidocs.neetocrm.com/api-reference-v1/team-members/list

bundled-v1/team-members.yaml GET /team_members
List team members in the workspace.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Remove team member
Source: https://apidocs.neetocrm.com/api-reference-v1/team-members/remove

bundled-v1/team-members.yaml DELETE /team_members/{team_member_id}
Remove a team member from the workspace.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Update team member details
Source: https://apidocs.neetocrm.com/api-reference-v1/team-members/update

bundled-v1/team-members.yaml PATCH /team_members/{team_member_id}
Update a team member.

> [!WARNING]
>
> **Deprecated:** This is a **v1** endpoint. It will continue to work, but we recommend migrating to
> the [v2 equivalent](/api) for improved REST compliance (correct HTTP status codes,
> consistent response envelopes, and hyphenated URLs).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Authentication
Source: https://apidocs.neetocrm.com/api/authentication

Learn how to authenticate your requests to the NeetoCRM API using API keys.

### Generating an API Key

To use the NeetoCRM APIs, you must first generate an API key:

1. Go to the **Admin panel** and click **API keys**.
2. Click **Add API key**. The **Add new API key** pane opens.
3. Enter a **Name** for the key.
4. Under **Type**, choose **General**. The **Zapier** type is only for the Zapier integration.
5. Pick an **Expiry date**, or check **Never expires**.
6. Click **Save changes**.
7. Copy the key from the **API keys** list using the copy icon. The key stays in the list, so you can copy it again later.

[Learn more about API keys here.](https://help.neetocrm.com/articles/api-keys)

### Making authenticated API requests

To authenticate your API requests, include a valid API key in the X-Api-Key header.

```bash theme={"system"}
curl https://{your-subdomain}.neetocrm.com/api/external/v1/contacts \
  -H 'X-Api-Key: your-api-key' \
  -H 'Content-Type: application/json'
```

### Header Format

Include your API key in the `X-Api-Key` header of every request:

```http theme={"system"}
X-Api-Key: your_api_key_here
```

> [!TIP]
>
> Generate separate API keys for different workspaces. An API key generated in
> one workspace will not work in another.

> [!WARNING]
>
> API keys provide access to sensitive data. Treat them like passwords and
> follow security best practices.

## Error Responses

### 401 Unauthorized

If your API key is missing, invalid, or expired, you'll receive a 401 error:

```json theme={"system"}
{
  "error": "Could not authenticate, invalid API Key"
}
```

### Common Authentication Issues

> **Invalid API key**
>
> **Problem**: API key is missing or invalid. \\
>
> **Solution**: Verify your API key is correct and hasn't been revoked/expired.

> **Incorrect workspace subdomain**
>
> **Problem**: Subdomain is left as the default value (**spinkart**) or
> incorrect.
>
> **Solution**: Verify your subdomain name is properly added in the request
> URL.


# Create company
Source: https://apidocs.neetocrm.com/api/companies/create

bundled/companies.yaml POST /companies
Create a new company in your workspace.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Delete company
Source: https://apidocs.neetocrm.com/api/companies/delete

bundled/companies.yaml DELETE /companies/{id}
Delete a company by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Get company
Source: https://apidocs.neetocrm.com/api/companies/get

bundled/companies.yaml GET /companies/{id}
Retrieve a single company by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# List companies
Source: https://apidocs.neetocrm.com/api/companies/list

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

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Update company
Source: https://apidocs.neetocrm.com/api/companies/update

bundled/companies.yaml PATCH /companies/{id}
Update an existing company by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Create contact
Source: https://apidocs.neetocrm.com/api/contacts/create

bundled/contacts.yaml POST /contacts
Create a new contact in your workspace.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Delete contact
Source: https://apidocs.neetocrm.com/api/contacts/delete

bundled/contacts.yaml DELETE /contacts/{id}
Delete a contact by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Get contact
Source: https://apidocs.neetocrm.com/api/contacts/get

bundled/contacts.yaml GET /contacts/{id}
Retrieve a single contact by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# List contacts
Source: https://apidocs.neetocrm.com/api/contacts/list

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

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Update contact
Source: https://apidocs.neetocrm.com/api/contacts/update

bundled/contacts.yaml PATCH /contacts/{id}
Update an existing contact by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Create deal
Source: https://apidocs.neetocrm.com/api/deals/create

bundled/deals.yaml POST /deals
Create a new deal in your workspace.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Delete deal
Source: https://apidocs.neetocrm.com/api/deals/delete

bundled/deals.yaml DELETE /deals/{id}
Delete a deal by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Get deal
Source: https://apidocs.neetocrm.com/api/deals/get

bundled/deals.yaml GET /deals/{id}
Retrieve a single deal by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# List deals
Source: https://apidocs.neetocrm.com/api/deals/list

bundled/deals.yaml GET /deals
Retrieve a list of all deals in your workspace. Results are ordered by creation date (newest first).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Update deal
Source: https://apidocs.neetocrm.com/api/deals/update

bundled/deals.yaml PATCH /deals/{id}
Update an existing deal by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Introduction
Source: https://apidocs.neetocrm.com/api/introduction

Welcome to the NeetoCRM API documentation.

The NeetoCRM API is organized around REST principles and uses standard HTTP response codes. All API endpoints return JSON responses and require authentication.

Before you start with NeetoCRM APIs you will need the following:

1. [Workspace subdomain](/api/workspace-subdomain).
2. [API key](/api/authentication).

## Rate Limiting

API requests are subject to rate limiting to ensure fair use. If you exceed the rate limit, you'll receive a 429 response. If you encounter this error try again after some time.

## Need help?

Visit our [help center](https://help.neetocrm.com), email us at [support@neetocrm.com](mailto:support@neetocrm.com), or join the [Neeto Community](https://neeto.com/community).

The community is powered by Slack and is the fastest way to get help directly from the developers, designers, and product folks building NeetoCRM.


# Create lead
Source: https://apidocs.neetocrm.com/api/leads/create

bundled/leads.yaml POST /leads
Create a new lead in your workspace.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Delete lead
Source: https://apidocs.neetocrm.com/api/leads/delete

bundled/leads.yaml DELETE /leads/{id}
Delete a lead by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Get lead
Source: https://apidocs.neetocrm.com/api/leads/get

bundled/leads.yaml GET /leads/{id}
Retrieve a single lead by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# List leads
Source: https://apidocs.neetocrm.com/api/leads/list

bundled/leads.yaml GET /leads
Retrieve a list of all leads in your workspace. Results are ordered by creation date (newest first).

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Update lead
Source: https://apidocs.neetocrm.com/api/leads/update

bundled/leads.yaml PATCH /leads/{id}
Update an existing lead by its ID.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Pagination
Source: https://apidocs.neetocrm.com/api/pagination

Learn how to handle paginated responses in the NeetoCRM API.

## Pagination Parameters

You can control pagination using the following query parameters:

**page\_number** `integer`

The page of results you want to retrieve (starting from 1).

**page\_size** `integer`

The number of items to return per page.

## Example Usage

Here's how to retrieve paginated results using cURL:

```bash cURL theme={"system"}
curl --request GET \
  --url "https://{your-subdomain}.neetocrm.com/api/external/v1/contacts?page_number=2&page_size=25" \
  --header 'X-Api-Key: your-api-key'
```

```javascript JavaScript theme={"system"}
const response = await fetch(
  "https://{your-subdomain}.neetocrm.com/api/external/v1/contacts?page_number=2&page_size=25",
  {
    method: "GET",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
  }
);

const data = await response.json();
console.log(data);
```

```python Python theme={"system"}
import requests

url = "https://{your-subdomain}.neetocrm.com/api/external/v1/contacts"
params = {
    "page_number": 2,
    "page_size": 25
}
headers = {
    "X-Api-Key": "your-api-key",
    "Content-Type": "application/json"
}

response = requests.get(url, params=params, headers=headers)
data = response.json()
print(data)
```

This retrieves the second page of contacts, with 25 results per page.

## Response Structure

Paginated responses include metadata about the pagination in JSON format:

```json Response Example theme={"system"}
{
  "contacts": [
    // ... array of contact objects
  ],
  "pagination": {
    "total_records": 150,
    "current_page_number": 2,
    "total_pages": 6,
    "page_size": 25
  }
}
```

**pagination.total\_records** `integer`

The total number of items across all pages.

**pagination.current\_page\_number** `integer`

The current page number (if pagination was used).

**pagination.total\_pages** `integer`

The total number of pages available (if pagination was used).

**pagination.page\_size** `integer`

The number of items per page.

## Default Behavior

> [!NOTE]
>
> If pagination parameters are not provided, default values will be applied: -
> **page\_number**: 1 (first page) - **page\_size**: 30 (30 items per page)

## Best Practices

1. **Start with reasonable page sizes**: Use page sizes between 10-100 items for optimal performance.
2. **Handle empty results**: Always check if the returned array is empty to detect the end of data.
3. **Use total\_records**: Use the `pagination.total_records` field to calculate the total number of pages needed.
4. **Implement error handling**: Handle cases where the requested page doesn't exist.


# HTTP response codes
Source: https://apidocs.neetocrm.com/api/response-codes

Learn about the HTTP status codes returned by the API.

## Success Codes

**200 OK**

The request was successful and the server returned the requested data.

**201 Created**

The resource was successfully created.

**204 No Content**

The request succeeded with no response body.

## Error codes

**400 Bad Request**

There was an issue with the request. This usually indicates malformed JSON,
missing required parameters, or invalid parameter values.

**401 Unauthorized**

The request needs to be authenticated. This typically means:

* Missing API key.
* Invalid API key.
* Expired API key.

**403 Forbidden**

An operation was not allowed. This could mean:

* Insufficient permissions for the requested action.
* Attempting to access a resource you don't own.
* API key doesn't have the required scope.

**404 Not Found**

The requested URL or resource was not found. This could indicate:

* Incorrect endpoint URL.
* Resource ID doesn't exist.
* Workspace subdomain is incorrect.

**422 Unprocessable entity**

The given request could not be processed by the server due to malformed
request. Check the request body once again.

**429 Too Many Requests**

Rate limit exceeded. Try again after some time or implement exponential backoff for retries.

**500 Internal Server Error**

An unexpected error occurred on the server. If this persists, please contact
support.

**501 Not Implemented**

The server does not support the functionality required to fulfill the request.

## Error Response Format

When an error occurs, the API returns a JSON response with error details:

```json Error Response Example theme={"system"}
{
  "error": "Error message describing what went wrong"
}
```

**error** `string`

A human-readable error message.

> [!TIP]
>
> When debugging API issues, the HTTP status
> code often provides
> the first clue about what went wrong. Start by checking the status code before
> diving into the response body.


# Add team members
Source: https://apidocs.neetocrm.com/api/team-members/add

bundled/team-members.yaml POST /team-members
Add team members to the workspace.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Get team member details
Source: https://apidocs.neetocrm.com/api/team-members/get

bundled/team-members.yaml GET /team-members/{team_member_id}
Retrieves details of a specific team member.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# List team members
Source: https://apidocs.neetocrm.com/api/team-members/list

bundled/team-members.yaml GET /team-members
List team members in the workspace.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Remove team member
Source: https://apidocs.neetocrm.com/api/team-members/remove

bundled/team-members.yaml DELETE /team-members/{team_member_id}
Remove a team member from the workspace.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Update team member
Source: https://apidocs.neetocrm.com/api/team-members/update

bundled/team-members.yaml PATCH /team-members/{team_member_id}
Update a team member.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace's subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](/api/workspace-subdomain).


# Workspace subdomain
Source: https://apidocs.neetocrm.com/api/workspace-subdomain

Learn how to find your workspace subdomain.

## What is a subdomain?

A subdomain is the part of your workspace URL that comes before the main domain. For example, in the URL:

```
https://spinkart.neetocrm.com
```

**spinkart** is the subdomain.

This subdomain is crucial for making API requests, as it identifies your specific workspace within NeetoCRM.

## Step-by-step instructions

**1. Locate your workspace URL**

You can usually find this in your browser's address bar when logged into your workspace.

Example:

```
https://your-subdomain.neetocrm.com
```

**2. Identify the main domain**

Our main domain is: `neetocrm.com`

**3. Extract the part before the main domain**

Everything before `neetocrm.com` is your subdomain.

**Example:**

* URL: `https://green-earth.neetocrm.com`
* Subdomain: `green-earth`

## Using Your Subdomain in API Requests

Once you've identified your subdomain, you'll use it in all API requests. The base URL format is:

```
https://{your-subdomain}.neetocrm.com/api/external/v1
```

For example, if your subdomain is `mycompany`, your API base URL would be:

```
https://mycompany.neetocrm.com/api/external/v1
```

## Common Examples

Here are some common subdomain patterns:

| Type | Example URL | Subdomain |
| - | - | - |
| Company | `https://acmecorp.neetocrm.com` | `acmecorp` |
| Department | `https://marketing.neetocrm.com` | `marketing` |
| Project | `https://product-launch.neetocrm.com` | `product-launch` |