Endpoint reference
Generated endpoint index from the deployed OpenAPI contract.
Generated from the Sqkii OpenAPI contract. SDK GeneratedApi methods use these operation IDs. Authentication and operation-specific validation remain enforced by the server. Some payloads use extensible JSON objects; inspect the contract and the resource guide before sending.
| Operation | Method | Path | Purpose |
|---|---|---|---|
acceptInvitation | POST | /api/v1/invitations/accept | Accept a team invitation |
completeConnection | POST | /api/v1/connections/complete | Complete Embedded Signup |
createApiKey | POST | /api/v1/api-keys | Create a scoped key; secret returned once |
createcontact | POST | /api/v1/contacts | Create contact |
createConversationNote | POST | /api/v1/conversations/{id}/notes | Add a conversation note |
createMessage | POST | /api/v1/numbers/{numberId}/messages | Queue a message idempotently |
createOrganization | POST | /api/v1/organizations | Create an organization and default project |
createoutlet | POST | /api/v1/outlets | Create outlet |
createproject | POST | /api/v1/projects | Create project |
createroute | POST | /api/v1/routes | Create route |
createSetupLink | POST | /api/v1/connections/setup-links | Create Embedded Signup v5 session |
createtemplate | POST | /api/v1/templates | Create template |
createWebhook | POST | /api/v1/webhooks | Create a signed webhook subscription |
deleteConversationContent | DELETE | /api/v1/conversations/{id}/content | Delete conversation content |
exportOrganization | GET | /api/v1/export | Export organization data |
get_api_v1_media_id_download | GET | /api/v1/media/{id}/download | Create a five-minute private download link |
getapi_key | GET | /api/v1/api-keys/{id} | Get api_key |
getaudit | GET | /api/v1/audit/{id} | Get audit |
getconnection | GET | /api/v1/connections/{id} | Get connection |
getcontact | GET | /api/v1/contacts/{id} | Get contact |
getconversation | GET | /api/v1/conversations/{id} | Get conversation |
getevent | GET | /api/v1/events/{id} | Get event |
getjob | GET | /api/v1/jobs/{id} | Get job |
getmember | GET | /api/v1/members/{id} | Get member |
getmessage | GET | /api/v1/messages/{id} | Get message |
getnumber | GET | /api/v1/numbers/{id} | Get number |
getOrganization | GET | /api/v1/organization | Get organization |
getoutlet | GET | /api/v1/outlets/{id} | Get outlet |
getOverview | GET | /api/v1/overview | Get dashboard overview |
getproject | GET | /api/v1/projects/{id} | Get project |
getroute | GET | /api/v1/routes/{id} | Get route |
getRuntime | GET | /api/v1/runtime | Public runtime capabilities |
getSettings | GET | /api/v1/settings | Get organization settings |
gettemplate | GET | /api/v1/templates/{id} | Get template |
getUsage | GET | /api/v1/usage | Get estimated current-month usage |
getwebhook | GET | /api/v1/webhooks/{id} | Get webhook |
handoffConversation | POST | /api/v1/conversations/{id}/handoff | Assign, pause or resume a conversation |
inviteMember | POST | /api/v1/members | Create a time-limited team invitation |
list_api_keys | GET | /api/v1/api-keys | List api-keys |
list_audit | GET | /api/v1/audit | List audit |
list_connections | GET | /api/v1/connections | List connections |
list_contacts | GET | /api/v1/contacts | List contacts |
list_conversations | GET | /api/v1/conversations | List conversations |
list_events | GET | /api/v1/events | List events |
list_jobs | GET | /api/v1/jobs | List jobs |
list_members | GET | /api/v1/members | List members |
list_messages | GET | /api/v1/messages | List messages |
list_numbers | GET | /api/v1/numbers | List numbers |
list_outlets | GET | /api/v1/outlets | List outlets |
list_projects | GET | /api/v1/projects | List projects |
list_routes | GET | /api/v1/routes | List routes |
list_templates | GET | /api/v1/templates | List templates |
list_webhooks | GET | /api/v1/webhooks | List webhooks |
listConversationMessages | GET | /api/v1/conversations/{id}/messages | List conversation messages |
listConversationNotes | GET | /api/v1/conversations/{id}/notes | List conversation notes |
listOrganizations | GET | /api/v1/organizations | List your organizations |
post_api_v1_media | POST | /api/v1/media | Upload private media for a connected number |
replayEvent | POST | /api/v1/events/{id}/replay | Replay an event to a webhook |
retryJob | POST | /api/v1/jobs/{id}/retry | Retry an eligible dead-letter job |
revokeApiKey | DELETE | /api/v1/api-keys/{id} | Revoke an API key |
selectOrganization | POST | /api/v1/session/organization | Select your active organization |
simulateInbound | POST | /api/v1/simulator/messages | Inject an isolated simulated inbound message |
updatecontact | PATCH | /api/v1/contacts/{id} | Update contact |
updateconversation | PATCH | /api/v1/conversations/{id} | Update conversation |
updatemember | PATCH | /api/v1/members/{id} | Update member |
updatenumber | PATCH | /api/v1/numbers/{id} | Update number |
updateOrganization | PATCH | /api/v1/organization | Update organization |
updateoutlet | PATCH | /api/v1/outlets/{id} | Update outlet |
updateproject | PATCH | /api/v1/projects/{id} | Update project |
updateroute | PATCH | /api/v1/routes/{id} | Update route |
updateSettings | PATCH | /api/v1/settings | Update retention settings |
updatewebhook | PATCH | /api/v1/webhooks/{id} | Update webhook |
Source contract: OpenAPI JSON.
Prepared 18 November 2026 · Sqkii Pte. Ltd.