# Neon Deer API

Source: https://neondeerdata.com/docs/api/

Work with the Neon Deer platform programmatically.

## Get started

Use the Neon Deer API from your applications and scripts, or connect an AI assistant through [MCP](https://neondeerdata.com/docs/api/mcp/). Organization admins choose the permissions and resources each connection can use.

The lookup-table API is available on Paid and during an active trial. The other API families and MCP require a separate alpha invitation for your organization. Having access to an app does not automatically grant its alpha API. Contact [support@neondeerdata.com](mailto:support@neondeerdata.com) to request access.

Start with [authentication](https://neondeerdata.com/docs/api/authentication/) and the [Quickstart](https://neondeerdata.com/docs/api/quickstart/). Use the [API Playground](https://neondeerdata.com/docs/api/testing/) to send requests with a key's actual access.

## Base URL

```text
https://api.neondeerdata.com/v1

```

Authenticated REST requests send the key in a header:

```http
Authorization: Bearer <API key>

```

Keep the key on your server, in an environment variable or secrets manager. Do not put it in a URL or browser code.

## API reference

| Resource                                                                      | What you can do                                                                                                                                                                         |
| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Meta](https://neondeerdata.com/docs/api/meta/)                               | Identify the connection and its organization, or check that the API responds.                                                                                                           |
| [Lookup tables](https://neondeerdata.com/docs/api/lookup-tables/)             | Read and write rows, maintain fields and workflow lookups, install library tables, and import CSV files.                                                                                |
| [Duplicate Detection](https://neondeerdata.com/docs/api/duplicate-detection/) | Configure matching rules, run scans, review results, assess matches, prepare and execute authorized merges, and unmerge records from saved backups by reconstructing them with new IDs. |
| [Scheduled runs](https://neondeerdata.com/docs/api/scheduled-runs/)           | Schedule records into Attio workflows, inspect runs, cancel work, and manage batch ownership.                                                                                           |
| [Workflow automations](https://neondeerdata.com/docs/api/automations/)        | Repeat task setup and inspect or acknowledge workflow failures.                                                                                                                         |
| [Email Notifications](https://neondeerdata.com/docs/api/email-notifications/) | Read delivery activity, change permitted settings including the subject prefix and BCC, and cancel waiting alerts.                                                                      |
| [Webhooks](https://neondeerdata.com/docs/api/webhooks/)                       | Receive signed events for Duplicate Detection and scheduled runs.                                                                                                                       |
| [Organization](https://neondeerdata.com/docs/api/organization/)               | Inspect setup, change the organization profile, and manage supported preferences.                                                                                                       |

## Permissions and writes

A connection's permissions, selected resources, your plan, and alpha access determine which requests it can make. Read [permissions](https://neondeerdata.com/docs/api/permissions/) before granting writes. A write can change a table, start an Attio workflow, or merge CRM records, depending on the operation.

Use the returned version when a request asks for `expected_version`. Keep the same request key when retrying the same write. Follow [operation status](https://neondeerdata.com/docs/api/operations/) when a response accepts work that continues afterward. See [requests and retries](https://neondeerdata.com/docs/api/requests/).

## OpenAPI

The [public OpenAPI document](https://neondeerdata.com/docs/api/meta/openapi/) describes generally available API families. Alpha operations may not appear there. Their request and response fields are documented in this reference. MCP tools and their arguments are listed in [MCP actions](https://neondeerdata.com/docs/api/mcp/actions/).