> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notealy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> REST API for managing contacts, companies, transactional email and email campaigns in Notealy.

The Notealy Public API is a JSON-over-HTTPS REST API. Use it to push contacts into the CRM from your website, sync companies with another source of truth, and dispatch transactional or campaign emails — all while letting workflows defined in the dashboard (automations, tags, pipelines) react to the data you send.

Working in TypeScript or Node? Reach for the official SDK — it wraps every endpoint listed here with typed inputs, automatic `429`/`5xx` retries, and a webhook signature verifier:

```bash theme={null}
pnpm add @notealy/sdk
```

See [SDKs](/sdks) for the full client surface. The rest of this guide uses raw HTTP so the examples work in any language.

## Base URL

```
https://thanos.notealy.com/v1
```

All endpoints are versioned under `/v1`. Breaking changes will be released under a new version prefix; additive changes ship in place.

## Authentication

Every request must carry a Bearer API token. The first call from any new integration should be `GET /v1/me` — it requires no scope and confirms the token is alive:

```bash theme={null}
curl https://thanos.notealy.com/v1/me \
  -H "Authorization: Bearer sk_live_..."
```

A `200` response returns the token's identity card and the organization it belongs to. Create tokens in the dashboard at **Settings → API Tokens**. They look like `sk_live_<random>` and are shown only once at creation — store them securely. See [Authentication](/authentication) for scopes and best practices.

## Content type

Request bodies are JSON. Set `Content-Type: application/json` on every `POST`, `PATCH` and `DELETE` request that has a body.

## Quick links

* [Quickstart: create a contact and trigger an automation](/guides/quickstart)
* [Authentication and scopes](/authentication)
* [Rate limits](/rate-limits)
* [Webhooks](/webhooks/overview)