Reference
Endpoints
Every endpoint of the GraphKit REST API v1, with the scope it needs.
Paths are relative to https://app.graphkit.com/api/v1. Every request needs an API key (see Authentication), and the conventions for errors, pagination and idempotency are in Conventions. The machine-readable spec for these endpoints is openapi.json.
| Endpoint | Method | Path | Scope |
|---|---|---|---|
| Get the current key | GET | /me | workspace:read |
| List accounts | GET | /accounts | senders:read |
| Get an account | GET | /accounts/{id} | senders:read |
| List leads | GET | /leads | leads:read |
| Create or merge a lead | POST | /leads | leads:write |
| Get a lead | GET | /leads/{id} | leads:read |
| List lists | GET | /lists | leads:read |
| Create a list | POST | /lists | leads:write |
| Add leads to a list | POST | /lists/{id}/leads | leads:write |
| List campaigns | GET | /campaigns | campaigns:read |
| Get a campaign | GET | /campaigns/{id} | campaigns:read |
| Get campaign stats | GET | /campaigns/{id}/stats | campaigns:read |
| Add leads to a campaign | POST | /campaigns/{id}/leads | campaigns:write |
| Pause a campaign | POST | /campaigns/{id}/pause | campaigns:write |
| Resume a campaign | POST | /campaigns/{id}/resume | campaigns:write |
| List conversations | GET | /conversations | inbox:read |
| List messages | GET | /conversations/{id}/messages | inbox:read |
| Send a reply | POST | /conversations/{id}/messages | inbox:write |
| List webhook endpoints | GET | /webhooks | webhooks:manage |
| Create a webhook endpoint | POST | /webhooks | webhooks:manage |
| Delete a webhook endpoint | DELETE | /webhooks/{id} | webhooks:manage |
| List event types | GET | /webhook-events | workspace:read |