Open Kweko
DocsAPI referenceWebhooksErrorsApps Open Kweko kweko.uz

API reference

API reference

Every endpoint of https://api.kweko.uz/v1, grouped by resource. The most used resources have their own pages with fields and examples.

Resources

LeadsDeals in a pipeline: create, move, win and lose. ContactsPeople with phones and emails. ConversationsChats from every channel, and sending messages. Webhooks APIManage webhooks and their deliveries. CompaniesOrganizations, with their STIR. TasksCalls, meetings and follow-ups with a due time. Notes and timelineThe history of a lead, contact or company. Pipelines and stagesThe stages leads move through. Custom fieldsThe workspace's own fields. ProductsThe catalog you add to leads. MembersThe people in the workspace. TagsColored labels shared by leads, contacts and companies.

All endpoints

This list is generated from the API's routes. The scope column is read from the permission checks in each endpoint's code: an endpoint marked Kweko app only refuses API keys and apps (it serves the Kweko web app), and one without a scope either needs none or checks permissions in a way this list cannot read; its resource page says which. Paths link to their detailed description where there is one.

/v1/ad-spend

MethodPathScope
GET/v1/ad-spend/aliases
PUT/v1/ad-spend/aliases
POST/v1/ad-spend/import
GET/v1/ad-spend/imports
DELETE/v1/ad-spend/imports/{id}
GET/v1/ad-spend/months
PUT/v1/ad-spend/months
GET/v1/ad-spend/rates
PUT/v1/ad-spend/rates

/v1/ai

MethodPathScope
DELETE/v1/ai/consentKweko app only
POST/v1/ai/consentKweko app only
POST/v1/ai/draftai:use
POST/v1/ai/requests/{id}/outcome
GET/v1/ai/settingsKweko app only
PATCH/v1/ai/settingsKweko app only
GET/v1/ai/summary
POST/v1/ai/summaryai:use
POST/v1/ai/translateai:use
GET/v1/ai/usageKweko app only

/v1/ai-agent

MethodPathScope
GET/v1/ai-agent
PUT/v1/ai-agent
GET/v1/ai-agent/conversationsmessages:read
POST/v1/ai-agent/sandboxautomations:manage

/v1/ai-drafts

MethodPathScope
GET/v1/ai-draftsmessages:read
POST/v1/ai-drafts/{id}/dismissmessages:read
POST/v1/ai-drafts/{id}/usemessages:read

/v1/analytics

MethodPathScope
GET/v1/analytics/dashboards/{name}reports:read
GET/v1/analytics/digestreports:read
PUT/v1/analytics/digestreports:read
GET/v1/analytics/digest/previewreports:read
GET/v1/analytics/drillreports:read
GET/v1/analytics/leaderboardreports:read
GET/v1/analytics/metrics
GET/v1/analytics/plansreports:read
PUT/v1/analytics/plansreports:read
GET/v1/analytics/plans/chancesreports:read
PUT/v1/analytics/plans/chancesreports:read
GET/v1/analytics/plans/progressreports:read
PUT/v1/analytics/plans/settingsreports:read
POST/v1/analytics/queryreports:read
POST/v1/analytics/recomputeKweko app only
GET/v1/analytics/roireports:read
GET/v1/analytics/score/mereports:read
GET/v1/analytics/settingsreports:read
PUT/v1/analytics/settingsKweko app only
GET/v1/analytics/tabsreports:read
GET/v1/analytics/teamreports:read

/v1/announcements

MethodPathScope
GET/v1/announcements
POST/v1/announcements/{id}/dismiss

/v1/api-keys

MethodPathScope
GET/v1/api-keysKweko app only
POST/v1/api-keysKweko app only
DELETE/v1/api-keys/{id}Kweko app only
GET/v1/api-keys/{id}Kweko app only
PATCH/v1/api-keys/{id}Kweko app only
GET/v1/api-keys/{id}/requestsKweko app only
POST/v1/api-keys/{id}/revokeKweko app only
POST/v1/api-keys/{id}/rotateKweko app only
GET/v1/api-keys/scopesKweko app only
GET/v1/api-keys/whoamiNo scope needed

/v1/app

MethodPathScope
GET/v1/app/installation
PUT/v1/app/installation/health

/v1/apps

MethodPathScope
POST/v1/apps/actionsKweko app only
POST/v1/apps/blocksKweko app only
GET/v1/apps/extension-points
GET/v1/apps/extensionsKweko app only
POST/v1/apps/frame-contextKweko app only
GET/v1/apps/installationsKweko app only
DELETE/v1/apps/installations/{id}Kweko app only
GET/v1/apps/installations/{id}Kweko app only
POST/v1/apps/installations/{id}/callKweko app only
PATCH/v1/apps/installations/{id}/settingsKweko app only
GET/v1/apps/marketplaceKweko app only
GET/v1/apps/marketplace/{app}Kweko app only
POST/v1/apps/marketplace/{app}/installKweko app only
GET/v1/apps/marketplace/categories
GET/v1/apps/scopes

/v1/audit-log

MethodPathScope
GET/v1/audit-logKweko app only

/v1/automation-runs

MethodPathScope
GET/v1/automation-runs/{id}
POST/v1/automation-runs/{id}/replay
POST/v1/automation-runs/{id}/stopautomations:manage automations:run leads:write

/v1/automations

MethodPathScope
GET/v1/automations
POST/v1/automations
DELETE/v1/automations/{id}
GET/v1/automations/{id}
PATCH/v1/automations/{id}
GET/v1/automations/{id}/ai-logautomations:manage
POST/v1/automations/{id}/disable
POST/v1/automations/{id}/enable
POST/v1/automations/{id}/runautomations:run
GET/v1/automations/{id}/runs
POST/v1/automations/{id}/testautomations:manage
POST/v1/automations/ai/testautomations:manage
GET/v1/automations/bot-presets
POST/v1/automations/dry-runautomations:manage
POST/v1/automations/pause
POST/v1/automations/resume
GET/v1/automations/settings
PATCH/v1/automations/settings
GET/v1/automations/templates
POST/v1/automations/templates/{tid}/install
POST/v1/automations/validate

/v1/billing

MethodPathScope
GET/v1/billing
GET/v1/billing/addons
POST/v1/billing/addons/checkout
POST/v1/billing/cancel
POST/v1/billing/checkout
POST/v1/billing/checkout/{id}/complete
GET/v1/billing/invoices
POST/v1/billing/pay
GET/v1/billing/plans
POST/v1/billing/quote
POST/v1/billing/resume

/v1/booking

MethodPathScope
GET/v1/booking
DELETE/v1/booking/exceptions/{memberID}/{day}
PUT/v1/booking/exceptions/{memberID}/{day}
POST/v1/booking/services
DELETE/v1/booking/services/{id}
PATCH/v1/booking/services/{id}
PATCH/v1/booking/settings
POST/v1/booking/setup

/v1/bookings

MethodPathScope
GET/v1/bookings
POST/v1/bookings/{id}/status
GET/v1/bookings/by-task/{taskID}

/v1/broadcasts

MethodPathScope
GET/v1/broadcastsKweko app only
POST/v1/broadcastsKweko app only
DELETE/v1/broadcasts/{id}Kweko app only
GET/v1/broadcasts/{id}Kweko app only
PATCH/v1/broadcasts/{id}Kweko app only
POST/v1/broadcasts/{id}/cancelKweko app only
POST/v1/broadcasts/{id}/pauseKweko app only
POST/v1/broadcasts/{id}/previewKweko app only
GET/v1/broadcasts/{id}/recipientsKweko app only
POST/v1/broadcasts/{id}/resumeKweko app only
POST/v1/broadcasts/{id}/sendKweko app only
POST/v1/broadcasts/{id}/testKweko app only

/v1/bulk

MethodPathScope
POST/v1/bulk/{entity}/preview
POST/v1/bulk/{entity}/run
GET/v1/bulk/jobs
GET/v1/bulk/jobs/{id}
POST/v1/bulk/jobs/{id}/undo

/v1/calendar

MethodPathScope
GET/v1/calendartasks:read
DELETE/v1/calendar/feed
GET/v1/calendar/feed
POST/v1/calendar/feed/rotate

/v1/calls

MethodPathScope
GET/v1/callscalls:write
GET/v1/calls/{id}calls:read
POST/v1/calls/{id}/hangupcalls:read
POST/v1/calls/{id}/outcomecalls:write
GET/v1/calls/{id}/recordingcalls:write
POST/v1/calls/{id}/transcribecalls:write
GET/v1/calls/{id}/transcriptcalls:read
POST/v1/calls/originatecalls:write
GET/v1/calls/transcriptionKweko app only
PATCH/v1/calls/transcriptionKweko app only

/v1/channels

MethodPathScope
GET/v1/channelsKweko app only
POST/v1/channelsKweko app only
DELETE/v1/channels/{id}Kweko app only
GET/v1/channels/{id}Kweko app only
PATCH/v1/channels/{id}Kweko app only
POST/v1/channels/{id}/disconnectKweko app only
POST/v1/channels/{id}/simulatemessages:send
POST/v1/channels/{id}/syncKweko app only
GET/v1/channels/{id}/templatesKweko app only
POST/v1/channels/{id}/templates/syncKweko app only
POST/v1/channels/{id}/testKweko app only

/v1/companies

MethodPathScope
GET/v1/companiescompanies:read
POST/v1/companiescompanies:write
DELETE/v1/companies/{id}companies:write
GET/v1/companies/{id}companies:read
PATCH/v1/companies/{id}companies:write
POST/v1/companies/{id}/restorecompanies:write

/v1/contacts

MethodPathScope
GET/v1/contactscontacts:read
POST/v1/contactscontacts:write
DELETE/v1/contacts/{id}contacts:write
GET/v1/contacts/{id}contacts:read
PATCH/v1/contacts/{id}contacts:write
DELETE/v1/contacts/{id}/opt-out
GET/v1/contacts/{id}/opt-out
POST/v1/contacts/{id}/opt-out
POST/v1/contacts/{id}/restorecontacts:write

/v1/conversations

MethodPathScope
GET/v1/conversationsmessages:read
GET/v1/conversations/{id}messages:read
POST/v1/conversations/{id}/assignconversations:manage
GET/v1/conversations/{id}/botmessages:read
POST/v1/conversations/{id}/bot/stopmessages:send
GET/v1/conversations/{id}/messagesmessages:read
POST/v1/conversations/{id}/messagesmessages:send
GET/v1/conversations/{id}/messages/{msg}/attachments/{n}messages:read
POST/v1/conversations/{id}/readmessages:read
POST/v1/conversations/{id}/reopenconversations:manage
POST/v1/conversations/{id}/resolveconversations:manage
POST/v1/conversations/{id}/snoozeconversations:manage
POST/v1/conversations/{id}/unreadmessages:read
GET/v1/conversations/countsmessages:read

/v1/crm

MethodPathScope
GET/v1/crm/members

/v1/crm-migrations

MethodPathScope
GET/v1/crm-migrationsKweko app only
POST/v1/crm-migrationsKweko app only
GET/v1/crm-migrations/{id}Kweko app only
PATCH/v1/crm-migrations/{id}Kweko app only
POST/v1/crm-migrations/{id}/cancelKweko app only
POST/v1/crm-migrations/{id}/purgeKweko app only
POST/v1/crm-migrations/{id}/resumeKweko app only
POST/v1/crm-migrations/{id}/runKweko app only

/v1/distribution

MethodPathScope
GET/v1/distribution
GET/v1/distribution/log
GET/v1/distribution/queuesautomations:manage
POST/v1/distribution/queues
DELETE/v1/distribution/queues/{id}
PATCH/v1/distribution/queues/{id}
PUT/v1/distribution/queues/order
PUT/v1/distribution/schedules/{memberID}

/v1/documents

MethodPathScope
GET/v1/documentsleads:read
POST/v1/documents/generateleads:write messages:send
POST/v1/documents/previewleads:write
GET/v1/documents/requisitesleads:write
PUT/v1/documents/requisitesKweko app only
GET/v1/documents/templatesleads:write
POST/v1/documents/templatesKweko app only
DELETE/v1/documents/templates/{id}Kweko app only
GET/v1/documents/templates/{id}leads:write
PATCH/v1/documents/templates/{id}Kweko app only
GET/v1/documents/variablesleads:write

/v1/duplicates

MethodPathScope
GET/v1/duplicates
POST/v1/duplicates/check
POST/v1/duplicates/dismiss
POST/v1/duplicates/merge
POST/v1/duplicates/merges/{id}/undo
GET/v1/duplicates/preview

/v1/email

MethodPathScope
GET/v1/email/detectKweko app only
GET/v1/email/signature
PUT/v1/email/signature

/v1/exports

MethodPathScope
GET/v1/exports
POST/v1/exports
GET/v1/exports/{id}

/v1/fields

MethodPathScope
GET/v1/fieldsNo scope needed
POST/v1/fieldsKweko app only
DELETE/v1/fields/{id}Kweko app only
PATCH/v1/fields/{id}Kweko app only

/v1/files

MethodPathScope
GET/v1/filesmessages:send notes:write tasks:write
POST/v1/filesmessages:send notes:write tasks:write
DELETE/v1/files/{id}
GET/v1/files/{id}
POST/v1/files/{id}/restore
GET/v1/files/usage

/v1/forms

MethodPathScope
GET/v1/forms
POST/v1/forms
DELETE/v1/forms/{id}
GET/v1/forms/{id}
PATCH/v1/forms/{id}
GET/v1/forms/{id}/submissions
GET/v1/forms/{id}/submissions/export

/v1/imports

MethodPathScope
GET/v1/imports
POST/v1/imports
GET/v1/imports/{id}
POST/v1/imports/{id}/preview
POST/v1/imports/{id}/run
POST/v1/imports/{id}/undo
GET/v1/imports/targets

/v1/integrations

MethodPathScope
GET/v1/integrations/didox/documentsleads:read
POST/v1/integrations/didox/documentsleads:write
POST/v1/integrations/didox/documents/{doc}/syncleads:read
GET/v1/integrations/gcal/busy
POST/v1/integrations/gcal/connect
DELETE/v1/integrations/gcal/me
GET/v1/integrations/gcal/me
GET/v1/integrations/healthKweko app only
GET/v1/integrations/health/{id}/eventsKweko app only
POST/v1/integrations/health/checkKweko app only
POST/v1/integrations/meta_ads/{id}/syncKweko app only
POST/v1/integrations/moysklad/{id}/syncKweko app only
POST/v1/integrations/odoo/{id}/syncKweko app only
GET/v1/integrations/stir/{stir}companies:write

/v1/invites

MethodPathScope
GET/v1/invitesKweko app only
POST/v1/invitesKweko app only
DELETE/v1/invites/{id}Kweko app only

/v1/leads

MethodPathScope
GET/v1/leadsleads:read
POST/v1/leadsleads:write
DELETE/v1/leads/{id}leads:write
GET/v1/leads/{id}leads:read
PATCH/v1/leads/{id}leads:write
GET/v1/leads/{id}/contactsleads:read
POST/v1/leads/{id}/contactsleads:write
DELETE/v1/leads/{id}/contacts/{contactID}leads:write
GET/v1/leads/{id}/productsleads:read
POST/v1/leads/{id}/productsleads:write
DELETE/v1/leads/{id}/products/{itemID}leads:write
PATCH/v1/leads/{id}/products/{itemID}leads:write
POST/v1/leads/{id}/restoreleads:write
GET/v1/leads/boardleads:read

/v1/limits

MethodPathScope
GET/v1/limits

/v1/members

MethodPathScope
GET/v1/membersusers:read
PATCH/v1/members/{id}Kweko app only
POST/v1/members/{id}/deactivateKweko app only
POST/v1/members/{id}/reactivateKweko app only
GET/v1/members/{id}/workloadKweko app only

/v1/mentions

MethodPathScope
POST/v1/mentions/read

/v1/messages

MethodPathScope
POST/v1/messages/{id}/retrymessages:send

/v1/my-work

MethodPathScope
GET/v1/my-work

/v1/notes

MethodPathScope
POST/v1/notesnotes:write
DELETE/v1/notes/{id}leads:write or contacts:write or companies:write
PATCH/v1/notes/{id}
DELETE/v1/notes/{id}/pinnotes:write
POST/v1/notes/{id}/pinnotes:write
POST/v1/notes/{id}/restore

/v1/notifications

MethodPathScope
GET/v1/notifications
POST/v1/notifications/read
DELETE/v1/notifications/telegram
GET/v1/notifications/telegram
POST/v1/notifications/telegram/link

/v1/onboarding

MethodPathScope
GET/v1/onboarding/checklist
POST/v1/onboarding/checklist
DELETE/v1/onboarding/sample-dataKweko app only
POST/v1/onboarding/sample-dataKweko app only
PUT/v1/onboarding/tips
GET/v1/onboarding/tours
PUT/v1/onboarding/tours/{id}

/v1/outreach

MethodPathScope
GET/v1/outreach/settingsKweko app only
PATCH/v1/outreach/settingsKweko app only

/v1/pipelines

MethodPathScope
GET/v1/pipelinesleads:read
POST/v1/pipelinesKweko app only
DELETE/v1/pipelines/{id}Kweko app only
PATCH/v1/pipelines/{id}Kweko app only
DELETE/v1/pipelines/{id}/pinleads:read
PUT/v1/pipelines/{id}/pinleads:read
POST/v1/pipelines/{id}/stagesKweko app only
DELETE/v1/pipelines/{id}/stages/{stageID}Kweko app only
PATCH/v1/pipelines/{id}/stages/{stageID}Kweko app only
PUT/v1/pipelines/{id}/stages/orderKweko app only

/v1/products

MethodPathScope
GET/v1/productsproducts:read
POST/v1/productsproducts:write
DELETE/v1/products/{id}products:write
GET/v1/products/{id}products:read
PATCH/v1/products/{id}products:write

/v1/proposals

MethodPathScope
GET/v1/proposalsleads:read
POST/v1/proposals
GET/v1/proposals/{id}leads:read
PATCH/v1/proposals/{id}leads:read
POST/v1/proposals/{id}/revokeleads:read
POST/v1/proposals/{id}/sendleads:read

/v1/push

MethodPathScope
GET/v1/push/config
DELETE/v1/push/subscriptions
POST/v1/push/subscriptions

/v1/query

MethodPathScope
POST/v1/query/{entity}
GET/v1/query/{entity}/count
POST/v1/query/{entity}/count
GET/v1/query/{entity}/fields
POST/v1/query/format
POST/v1/query/leads/board
POST/v1/query/parse

/v1/saved-replies

MethodPathScope
GET/v1/saved-repliesmessages:read
POST/v1/saved-replies
DELETE/v1/saved-replies/{id}
PATCH/v1/saved-replies/{id}
PUT/v1/saved-replies/order
MethodPathScope
GET/v1/searchmessages:read tasks:read

/v1/segments

MethodPathScope
GET/v1/segments
POST/v1/segmentsKweko app only
DELETE/v1/segments/{id}Kweko app only
GET/v1/segments/{id}
PATCH/v1/segments/{id}Kweko app only
GET/v1/segments/{id}/count

/v1/sequences

MethodPathScope
POST/v1/sequences/{id}/enrollautomations:run

/v1/sms

MethodPathScope
POST/v1/sms/bulkmessages:send
GET/v1/sms/estimate
GET/v1/sms/messagesleads:read messages:read
POST/v1/sms/sendmessages:send

/v1/support

MethodPathScope
POST/v1/support/messagesKweko app only
POST/v1/support/readKweko app only
GET/v1/support/threadKweko app only

/v1/tags

MethodPathScope
GET/v1/tagsleads:read or contacts:read or companies:read
POST/v1/tags
DELETE/v1/tags/{id}tags:manage
PATCH/v1/tags/{id}tags:manage
POST/v1/tags/{id}/mergetags:manage
PATCH/v1/tags/settingstags:manage

/v1/tasks

MethodPathScope
GET/v1/taskstasks:read
POST/v1/taskstasks:write
DELETE/v1/tasks/{id}tasks:write
GET/v1/tasks/{id}tasks:read
PATCH/v1/tasks/{id}tasks:write
POST/v1/tasks/{id}/completetasks:write
POST/v1/tasks/{id}/reopentasks:write
POST/v1/tasks/{id}/rescheduletasks:write
POST/v1/tasks/{id}/restoretasks:write
POST/v1/tasks/{id}/snoozetasks:write
GET/v1/tasks/assignees
POST/v1/tasks/bulk-complete

/v1/telephony

MethodPathScope
GET/v1/telephony/accounts/{id}/extensionsKweko app only
PUT/v1/telephony/accounts/{id}/extensionsKweko app only
POST/v1/telephony/accounts/{id}/simulateKweko app only
GET/v1/telephony/mecalls:write

/v1/timeline

MethodPathScope
GET/v1/timelineleads:read or contacts:read or companies:read

/v1/usage

MethodPathScope
GET/v1/usage
POST/v1/usage/restrictions/{id}/review

/v1/views

MethodPathScope
GET/v1/views
POST/v1/viewsKweko app only
DELETE/v1/views/{id}Kweko app only
PATCH/v1/views/{id}Kweko app only

/v1/webhooks

MethodPathScope
GET/v1/webhookswebhooks:manage
POST/v1/webhookswebhooks:manage
DELETE/v1/webhooks/{id}webhooks:manage
GET/v1/webhooks/{id}webhooks:manage
PATCH/v1/webhooks/{id}webhooks:manage
GET/v1/webhooks/{id}/deliverieswebhooks:manage
GET/v1/webhooks/{id}/deliveries/{did}webhooks:manage
POST/v1/webhooks/{id}/deliveries/{did}/replaywebhooks:manage
POST/v1/webhooks/{id}/enable
POST/v1/webhooks/{id}/pingwebhooks:manage
POST/v1/webhooks/{id}/rotate-secretwebhooks:manage
GET/v1/webhooks/{id}/secretKweko app only
GET/v1/webhooks/eventswebhooks:manage

/v1/widget

MethodPathScope
GET/v1/widget/settings
PATCH/v1/widget/settings

/v1/workspace

MethodPathScope
GET/v1/workspace
PATCH/v1/workspaceKweko app only
DELETE/v1/workspace/deletion
POST/v1/workspace/deletion
GET/v1/workspace/security
PATCH/v1/workspace/securityKweko app only