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

# REST API reference for the Orbit contacts endpoint

> Orbit REST API reference for listing contacts from your private network with Bearer auth, cursor pagination, JSON response shape, and error codes.

# REST API

Orbit's public HTTP surface is read-only and scoped to **your** network.

## Authentication

```http theme={null}
Authorization: Bearer orb_live_…
```

Create keys in [API keys](/developers/api-keys). Scope today: `contacts:read`.

## Interactive reference

Use the generated **API reference** (sidebar → Developers → API reference) for the live playground against `GET /api/v1/contacts`.

## Quick example

```bash theme={null}
curl "https://orbitmy.co/api/v1/contacts?limit=25" \
  -H "Authorization: Bearer orb_live_…" \
  -H "Accept: application/json"
```

Response shape:

```json theme={null}
{
  "data": [
    {
      "id": "…",
      "name": "Ada Lovelace",
      "company": "Analytical Engines",
      "title": "Chief Visionary"
    }
  ],
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 1,
    "nextOffset": null
  }
}
```

Use `id` as the stable key for [MCP `get_orbit_contact`](/developers/mcp).

## Errors

| Status | Meaning                                |
| ------ | -------------------------------------- |
| `401`  | Missing or invalid key                 |
| `403`  | Plan or scope does not allow this call |
| `5xx`  | Temporary server issue                 |

For agent tool-calling, prefer [MCP](/developers/mcp).