# Orbits API

> Orbits is a personal CRM for managing your professional network. The API lets you programmatically access and manage your contacts.

## API Base URL
https://orbits.so/api/v1

## Authentication
All requests require an API key in the Authorization header:
```
Authorization: Bearer orb_YOUR_API_KEY
```

## Endpoints

### GET /network
List all contacts. Supports search with `?q=` (searches name, company, role, notes, email, and group names), filter by `?company=` or `?group=`.
Sort with `?sort=` (firstName, lastName, company, createdAt) and `?order=` (asc, desc).
Add `?include=relationships` to get graph edges.

### GET /network/recent
Get recently added contacts sorted by creation date (newest first). Optional: `?limit=` (default 15, max 100).

### GET /profile/{username}
Get a public profile by username (only returns data for profiles marked public).

### GET /me
Get the authenticated user's info, including their Orbits username (if set).

### GET /contacts/{id}
Get a single contact by ID.

### POST /contacts
Create a contact. Required: `firstName`. Optional: `lastName`, `email`, `company`, `role`, `notes`, `meetingContext`, `birthday`, `socialLinks`, `connectedThrough`, `groupIds`.

### PATCH /contacts/{id}
Update a contact. Only send fields you want to change.

### POST /contacts/bulk
Import up to 100 contacts at once. Body: `{ "contacts": [...], "groupIds": [], "meetingContext": "" }`

### GET /groups
List all groups.

### POST /groups
Create a group. Required: `name`. Optional: `description`.

## Rate Limits
- Read: 100/min
- Write: 20/min
- Bulk: 5/min

## OpenAPI Spec
Full machine-readable spec at: https://orbits.so/openapi.yaml

## More Info
- Docs: https://orbits.so/developer/docs
- Contact: maya@orbits.so