Skip to main content

Step 1: Make Your First API Call

Let’s retrieve all contacts in your workspace using a GET request:
curl -X GET "https://{your-subdomain}.neetocrm.com/api/external/v1/contacts" \
  -H "X-Api-Key: your-api-key" \
  -H "Content-Type: application/json"
Replace your-subdomain with your actual workspace subdomain and your-api-key with your generated API key.

Step 2: Understanding the Response

A successful response will look like this JSON format:
{
  "contacts": [
    {
      "id": "1",
      "name": "John Doe",
      "email": "john@example.com",
      "phone_number": "+1234567890",
      "company_id": "1",
      "organization_id": "1",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  }
}

Next Steps

Now that you’ve made your first API call, you can: