Console
Documentation/Endpoint reference

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.

OperationMethodPathPurpose
acceptInvitationPOST/api/v1/invitations/acceptAccept a team invitation
completeConnectionPOST/api/v1/connections/completeComplete Embedded Signup
createApiKeyPOST/api/v1/api-keysCreate a scoped key; secret returned once
createcontactPOST/api/v1/contactsCreate contact
createConversationNotePOST/api/v1/conversations/{id}/notesAdd a conversation note
createMessagePOST/api/v1/numbers/{numberId}/messagesQueue a message idempotently
createOrganizationPOST/api/v1/organizationsCreate an organization and default project
createoutletPOST/api/v1/outletsCreate outlet
createprojectPOST/api/v1/projectsCreate project
createroutePOST/api/v1/routesCreate route
createSetupLinkPOST/api/v1/connections/setup-linksCreate Embedded Signup v5 session
createtemplatePOST/api/v1/templatesCreate template
createWebhookPOST/api/v1/webhooksCreate a signed webhook subscription
deleteConversationContentDELETE/api/v1/conversations/{id}/contentDelete conversation content
exportOrganizationGET/api/v1/exportExport organization data
get_api_v1_media_id_downloadGET/api/v1/media/{id}/downloadCreate a five-minute private download link
getapi_keyGET/api/v1/api-keys/{id}Get api_key
getauditGET/api/v1/audit/{id}Get audit
getconnectionGET/api/v1/connections/{id}Get connection
getcontactGET/api/v1/contacts/{id}Get contact
getconversationGET/api/v1/conversations/{id}Get conversation
geteventGET/api/v1/events/{id}Get event
getjobGET/api/v1/jobs/{id}Get job
getmemberGET/api/v1/members/{id}Get member
getmessageGET/api/v1/messages/{id}Get message
getnumberGET/api/v1/numbers/{id}Get number
getOrganizationGET/api/v1/organizationGet organization
getoutletGET/api/v1/outlets/{id}Get outlet
getOverviewGET/api/v1/overviewGet dashboard overview
getprojectGET/api/v1/projects/{id}Get project
getrouteGET/api/v1/routes/{id}Get route
getRuntimeGET/api/v1/runtimePublic runtime capabilities
getSettingsGET/api/v1/settingsGet organization settings
gettemplateGET/api/v1/templates/{id}Get template
getUsageGET/api/v1/usageGet estimated current-month usage
getwebhookGET/api/v1/webhooks/{id}Get webhook
handoffConversationPOST/api/v1/conversations/{id}/handoffAssign, pause or resume a conversation
inviteMemberPOST/api/v1/membersCreate a time-limited team invitation
list_api_keysGET/api/v1/api-keysList api-keys
list_auditGET/api/v1/auditList audit
list_connectionsGET/api/v1/connectionsList connections
list_contactsGET/api/v1/contactsList contacts
list_conversationsGET/api/v1/conversationsList conversations
list_eventsGET/api/v1/eventsList events
list_jobsGET/api/v1/jobsList jobs
list_membersGET/api/v1/membersList members
list_messagesGET/api/v1/messagesList messages
list_numbersGET/api/v1/numbersList numbers
list_outletsGET/api/v1/outletsList outlets
list_projectsGET/api/v1/projectsList projects
list_routesGET/api/v1/routesList routes
list_templatesGET/api/v1/templatesList templates
list_webhooksGET/api/v1/webhooksList webhooks
listConversationMessagesGET/api/v1/conversations/{id}/messagesList conversation messages
listConversationNotesGET/api/v1/conversations/{id}/notesList conversation notes
listOrganizationsGET/api/v1/organizationsList your organizations
post_api_v1_mediaPOST/api/v1/mediaUpload private media for a connected number
replayEventPOST/api/v1/events/{id}/replayReplay an event to a webhook
retryJobPOST/api/v1/jobs/{id}/retryRetry an eligible dead-letter job
revokeApiKeyDELETE/api/v1/api-keys/{id}Revoke an API key
selectOrganizationPOST/api/v1/session/organizationSelect your active organization
simulateInboundPOST/api/v1/simulator/messagesInject an isolated simulated inbound message
updatecontactPATCH/api/v1/contacts/{id}Update contact
updateconversationPATCH/api/v1/conversations/{id}Update conversation
updatememberPATCH/api/v1/members/{id}Update member
updatenumberPATCH/api/v1/numbers/{id}Update number
updateOrganizationPATCH/api/v1/organizationUpdate organization
updateoutletPATCH/api/v1/outlets/{id}Update outlet
updateprojectPATCH/api/v1/projects/{id}Update project
updateroutePATCH/api/v1/routes/{id}Update route
updateSettingsPATCH/api/v1/settingsUpdate retention settings
updatewebhookPATCH/api/v1/webhooks/{id}Update webhook

Source contract: OpenAPI JSON.

Prepared 18 November 2026 · Sqkii Pte. Ltd.