Quick Start

Use this quick start to get from initial access to your first successful API calls in beta.

Recommended Sequence

1. Read Getting an API Key to understand how requests are authenticated.
2. Read Rate Limiting to understand per-key request-window limits and the headers returned on each response.
3. Use the OPENAPI reference to inspect the available endpoints and payloads.
4. Use the Organisation OPENAPI reference to discover the orgId and workspaceId values required by most workspace-scoped endpoints.
5. Continue with Creating your first contact for a concrete end-to-end workflow.

Suggested First Calls

• GET /utils/health
• GET /organisation
• GET /organisation/{orgId}/workspace
• POST /organisation/{orgId}/workspace/{workspaceId}/contact