# SalesQL API — Getting Started

> Enrich people and organizations with verified B2B contact data over a simple REST API.

- Base URL: https://api-public.salesql.com/v1
- Auth: `Authorization: Bearer <API_KEY>` (create a key in the dashboard → Settings → API Access; paid plans).
- Interactive reference (live OpenAPI): https://salesql.com/docs/api
- OpenAPI spec: https://api-public.salesql.com/openapi

## Endpoints

- `GET /persons/enrich` — Enrich a single person (consumes credits)
- `POST /persons/enrich/bulk` — Enrich up to 100 people (consumes credits)
- `GET /organizations/enrich` — Enrich a single organization (consumes credits)
- `POST /organizations/enrich/bulk` — Enrich up to 100 organizations (consumes credits)
- `GET /allowance` — Credits, plan and rate limits (free)

## Quickstart

### Enrich a person by LinkedIn URL

Reveal work email, phone, job title and company.

```bash
curl -G "https://api-public.salesql.com/v1/persons/enrich" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "linkedin_url=https://www.linkedin.com/in/example"
```

### Enrich a person by name + company

When you don’t have the LinkedIn URL.

```bash
curl -G "https://api-public.salesql.com/v1/persons/enrich" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "full_name=Jane Doe" \
  --data-urlencode "organization_domain=acme.com"
```

### Enrich an organization by domain

Industry, size, HQ location, logo and LinkedIn.

```bash
curl -G "https://api-public.salesql.com/v1/organizations/enrich" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "organization_domain=acme.com"
```

### Check credits & rate limits

Free — this call does not consume credits.

```bash
curl "https://api-public.salesql.com/v1/allowance" \
  -H "Authorization: Bearer YOUR_API_KEY"
```