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

# Quickstart

> From no key to your first five people.

Get an API key and list the five people with the best fit score.

**1. Create a key**

```bash theme={null}
export ZIPLINED_API_KEY=zpl_...
```

In the app, go to **Settings, Integrations, API keys**. Create a key with scope `read`.
It is shown exactly once.

**2. Make the first call**

```bash curl theme={null}
curl -H "Authorization: Bearer $ZIPLINED_API_KEY" \
  "https://api.ziplined.io/v1/people?limit=5&sort=fit"
```

```javascript Node theme={null}
const res = await fetch(
  "https://api.ziplined.io/v1/people?limit=5&sort=fit",
  { headers: { Authorization: `Bearer ${process.env.ZIPLINED_API_KEY}` } },
);
const { data, total, next_cursor } = await res.json();
```

```python Python theme={null}
import os, requests

res = requests.get(
    "https://api.ziplined.io/v1/people",
    params={"limit": 5, "sort": "fit"},
    headers={"Authorization": f"Bearer {os.environ['ZIPLINED_API_KEY']}"},
)
body = res.json()
```

The workspace comes from the key. There is nothing else to pass.

**3. Read the answer**

```json theme={null}
{
  "data": [
    {
      "id": "7b1f...",
      "name": "Jane Doe",
      "job_title": "Head of Growth",
      "company": "Acme BV",
      "country": "NL",
      "stage": "lead",
      "fit": { "score": 84, "tier": "high" },
      "warmth": { "score": 61, "tier": "warm" },
      "last_engaged_at": "2026-09-11T08:12:00.000Z",
      "outreach_count": 0
    }
  ],
  "next_cursor": "eyJvIjo1fQ",
  "total": 218
}
```

`data` is the page. `total` is how many match before paging. Pass `next_cursor` back as
`?cursor=` for the next page.

## Next

> [card] [API basics](https://docs.ziplined.io/api/basics.md)
>
> Scopes, paging, idempotency and rate limits.

> [card] [Concepts](https://docs.ziplined.io/concepts.md)
>
> Fit, warmth, stage, audiences and sources.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.