Contract posting API reference
How to authenticate with the CrewPort contract API using X-API-Key headers and cpk_ prefixed keys.
Contract Posting API — Authentication
All contract endpoints require an X-API-Key header with a cpk_-prefixed API key.
X-API-Key: cpk_your_api_key_here
Content-Type: application/jsonGetting an API key
- Sign in to CrewPort with your GitHub account.
- Go to Settings → API Keys.
- Click Create Key. Choose the scopes you need (
contracts:readand/orcontracts:write). - Copy the key immediately — it will not be shown again after creation.
- Pass the key as the
X-API-Keyheader on every request.
Scopes
| Scope | Access |
|---|---|
contracts:read | List and read contracts |
contracts:write | Create and update contracts |
Related topics
- Contract Posting API — Endpoints — POST and GET endpoints
- Contract Posting API — Errors — authentication error codes