Endpoint index¶
Every route the API exposes, generated from the OpenAPI schema. The curated pages in this section explain the endpoints you are most likely to need; this table exists so nothing is invisible.
Interactive versions of the same schema are served by a running backend at
/swagger-ui/ and /api/schema/redoc/, with the raw document at /schema/.
Note
This page is generated by backend/scripts/generate_endpoint_index.py.
Edit that script, not this file.
| Path | Methods |
|---|---|
/api/accounts/ |
GET, POST |
/api/accounts/attachment/{id}/ |
DELETE |
/api/accounts/comment/{id}/ |
DELETE, PATCH, PUT |
/api/accounts/{id}/ |
DELETE, GET, PATCH, POST, PUT |
/api/accounts/{id}/create_mail/ |
POST |
/api/activities/ |
GET |
/api/api-settings/ |
GET, POST |
/api/api-settings/{id}/ |
DELETE, GET, PATCH, PUT |
/api/attachments/{id}/download/ |
GET |
/api/auth/google/ |
POST |
/api/auth/google/callback/ |
POST |
/api/auth/logout/ |
POST |
/api/auth/magic-link/request/ |
POST |
/api/auth/magic-link/verify-code/ |
POST |
/api/auth/magic-link/verify/ |
POST |
/api/auth/me/ |
GET |
/api/auth/profile/ |
GET |
/api/auth/refresh-token/ |
POST |
/api/auth/switch-org/ |
POST |
/api/boards/ |
GET, POST |
/api/boards/columns/{column_pk}/tasks/ |
GET, POST |
/api/boards/tasks/{id}/ |
DELETE, PUT |
/api/boards/{board_pk}/columns/ |
GET, POST |
/api/boards/{id}/ |
DELETE, GET, PATCH, PUT |
/api/business-hours/calendar/ |
GET, PUT |
/api/business-hours/calendar/{id}/ |
GET, PUT |
/api/business-hours/calendar/{id}/holidays/ |
POST |
/api/business-hours/calendar/{id}/holidays/{hid}/ |
DELETE |
/api/cases/ |
GET, POST |
/api/cases/analytics/agents/ |
GET |
/api/cases/analytics/backlog/ |
GET |
/api/cases/analytics/drilldown/ |
GET |
/api/cases/analytics/export/ |
GET |
/api/cases/analytics/frt/ |
GET |
/api/cases/analytics/mttr/ |
GET |
/api/cases/analytics/service/ |
GET |
/api/cases/analytics/sla/ |
GET |
/api/cases/approval-rules/ |
GET, POST |
/api/cases/approval-rules/{id}/ |
DELETE, GET, PUT |
/api/cases/approvals/ |
GET |
/api/cases/approvals/{id}/approve/ |
POST |
/api/cases/approvals/{id}/cancel/ |
POST |
/api/cases/approvals/{id}/reject/ |
POST |
/api/cases/attachment/{id}/ |
DELETE |
/api/cases/bulk/delete/ |
POST |
/api/cases/bulk/update/ |
POST |
/api/cases/comment/{id}/ |
DELETE, PATCH, PUT |
/api/cases/csat/aggregate/ |
GET |
/api/cases/escalation-policies/ |
GET, POST |
/api/cases/escalation-policies/{id}/ |
DELETE, GET, PUT |
/api/cases/import/commit/ |
POST |
/api/cases/import/preview/ |
POST |
/api/cases/inbound/{mailbox_id}/ |
POST |
/api/cases/kanban/ |
GET |
/api/cases/mailboxes/ |
GET, POST |
/api/cases/mailboxes/{id}/ |
DELETE, GET, PUT |
/api/cases/pipelines/ |
GET, POST |
/api/cases/pipelines/{id}/ |
DELETE, GET, PUT |
/api/cases/pipelines/{pipeline_pk}/stages/ |
POST |
/api/cases/pipelines/{pipeline_pk}/stages/reorder/ |
POST |
/api/cases/reopen-policy/ |
GET, PUT |
/api/cases/routing-rules/ |
GET, POST |
/api/cases/routing-rules/{id}/ |
DELETE, GET, PUT |
/api/cases/routing-rules/{id}/test/ |
POST |
/api/cases/solutions/ |
GET, POST |
/api/cases/solutions/{id}/ |
DELETE, GET, PATCH, PUT |
/api/cases/solutions/{id}/publish/ |
POST |
/api/cases/solutions/{id}/unpublish/ |
POST |
/api/cases/stages/{id}/ |
DELETE, PUT |
/api/cases/watching/ |
GET |
/api/cases/{id}/ |
DELETE, GET, PATCH, POST, PUT |
/api/cases/{id}/activities/ |
GET |
/api/cases/{id}/close-with-children/ |
POST |
/api/cases/{id}/link/ |
POST |
/api/cases/{id}/merge/{into_id}/ |
POST |
/api/cases/{id}/move/ |
PATCH |
/api/cases/{id}/request-approval/ |
POST |
/api/cases/{id}/solution-suggestions/ |
GET |
/api/cases/{id}/solutions/ |
DELETE, POST |
/api/cases/{id}/solutions/{solution_pk}/ |
DELETE, POST |
/api/cases/{id}/time-entries/ |
GET, POST |
/api/cases/{id}/time-entries/start/ |
POST |
/api/cases/{id}/time-summary/ |
GET |
/api/cases/{id}/tree/ |
GET |
/api/cases/{id}/unmerge/ |
POST |
/api/cases/{id}/watch/ |
DELETE, POST |
/api/cases/{id}/watchers/ |
GET |
/api/contacts/ |
GET, POST |
/api/contacts/attachment/{id}/ |
DELETE |
/api/contacts/comment/{id}/ |
DELETE, PATCH, PUT |
/api/contacts/import/commit/ |
POST |
/api/contacts/import/preview/ |
POST |
/api/contacts/{id}/ |
DELETE, GET, PATCH, POST, PUT |
/api/custom-fields/ |
GET, POST |
/api/custom-fields/{id}/ |
DELETE, GET, PUT |
/api/dashboard/ |
GET |
/api/dashboard/today/ |
GET |
/api/documents/ |
GET, POST |
/api/documents/{id}/ |
DELETE, GET, PATCH, PUT |
/api/documents/{id}/download/ |
GET |
/api/invoices/ |
GET, POST |
/api/invoices/attachments/{id}/ |
DELETE |
/api/invoices/comments/{id}/ |
DELETE, PUT |
/api/invoices/estimates/ |
GET, POST |
/api/invoices/estimates/{id}/ |
DELETE, GET, PUT |
/api/invoices/estimates/{id}/convert/ |
POST |
/api/invoices/estimates/{id}/pdf/ |
GET |
/api/invoices/estimates/{id}/send/ |
POST |
/api/invoices/from-opportunity/{opportunity_id}/ |
POST |
/api/invoices/from-time-entries/ |
POST |
/api/invoices/products/ |
GET, POST |
/api/invoices/products/{id}/ |
DELETE, GET, PUT |
/api/invoices/recurring/ |
GET, POST |
/api/invoices/recurring/{id}/ |
DELETE, GET, PUT |
/api/invoices/recurring/{id}/toggle/ |
POST |
/api/invoices/reports/aging/ |
GET |
/api/invoices/reports/dashboard/ |
GET |
/api/invoices/reports/revenue/ |
GET |
/api/invoices/templates/ |
GET, POST |
/api/invoices/templates/{id}/ |
DELETE, GET, PUT |
/api/invoices/templates/{id}/editor/ |
GET |
/api/invoices/{id}/ |
GET, PUT |
/api/invoices/{id}/cancel/ |
POST |
/api/invoices/{id}/duplicate/ |
POST |
/api/invoices/{id}/mark-paid/ |
POST |
/api/invoices/{id}/pdf/ |
GET |
/api/invoices/{id}/send/ |
POST |
/api/invoices/{invoice_id}/attachments/ |
POST |
/api/invoices/{invoice_id}/comments/ |
POST |
/api/invoices/{invoice_id}/line-items/ |
GET, POST |
/api/invoices/{invoice_id}/line-items/{id}/ |
DELETE, PUT |
/api/invoices/{invoice_id}/payments/ |
GET, POST |
/api/invoices/{invoice_id}/payments/{id}/ |
DELETE |
/api/leads/ |
GET, POST |
/api/leads/attachment/{id}/ |
DELETE |
/api/leads/comment/{id}/ |
DELETE, PATCH, PUT |
/api/leads/create-from-site/ |
POST |
/api/leads/kanban/ |
GET |
/api/leads/pipelines/ |
GET, POST |
/api/leads/pipelines/{id}/ |
DELETE, GET, PUT |
/api/leads/pipelines/{pipeline_pk}/stages/ |
POST |
/api/leads/pipelines/{pipeline_pk}/stages/reorder/ |
POST |
/api/leads/stages/{id}/ |
DELETE, PUT |
/api/leads/upload/ |
POST |
/api/leads/{id}/ |
DELETE, GET, PATCH, POST, PUT |
/api/leads/{id}/move/ |
PATCH |
/api/macros/ |
GET, POST |
/api/macros/{id}/ |
DELETE, GET, PATCH, PUT |
/api/macros/{id}/render/ |
POST |
/api/notifications/ |
GET |
/api/notifications/read-all/ |
POST |
/api/notifications/{id}/ |
DELETE |
/api/notifications/{id}/read/ |
POST |
/api/opportunities/ |
GET, POST |
/api/opportunities/aging-config/ |
GET, PUT |
/api/opportunities/attachment/{id}/ |
DELETE |
/api/opportunities/comment/{id}/ |
DELETE, PATCH, PUT |
/api/opportunities/goals/ |
GET, POST |
/api/opportunities/goals/history/ |
GET |
/api/opportunities/goals/leaderboard/ |
GET |
/api/opportunities/goals/{id}/ |
DELETE, GET, PUT |
/api/opportunities/kanban/ |
GET |
/api/opportunities/{id}/ |
DELETE, GET, PATCH, POST, PUT |
/api/opportunities/{id}/move/ |
PATCH |
/api/opportunities/{opportunity_id}/line-items/ |
GET, POST |
/api/opportunities/{opportunity_id}/line-items/{line_item_id}/ |
DELETE, GET, PUT |
/api/org/ |
GET, POST |
/api/org/api-key/ |
GET, POST |
/api/org/settings/ |
GET, PATCH |
/api/org/timezones/ |
GET |
/api/org/tokens/ |
GET |
/api/org/tokens/{id}/ |
DELETE |
/api/org/{id}/ |
GET, PATCH, PUT |
/api/packs/ |
GET |
/api/packs/sample-data/ |
DELETE |
/api/packs/{pack_id}/apply/ |
POST |
/api/portal/articles/ |
GET |
/api/portal/articles/suggest/ |
GET |
/api/portal/articles/{id}/ |
GET |
/api/portal/cases/ |
GET, POST |
/api/portal/cases/{id}/ |
GET |
/api/portal/cases/{id}/comment/ |
POST |
/api/portal/login/{org_id}/request/ |
POST |
/api/portal/login/{org_id}/verify/ |
POST |
/api/profile/ |
GET, PATCH |
/api/profile/tokens/ |
GET, POST |
/api/profile/tokens/{id}/ |
DELETE |
/api/public/csat/{token}/ |
GET, POST |
/api/public/estimate/{token}/ |
GET |
/api/public/estimate/{token}/accept/ |
POST |
/api/public/estimate/{token}/decline/ |
POST |
/api/public/estimate/{token}/pdf/ |
GET |
/api/public/forms/{org_id}/{form_id}/embed.js |
GET |
/api/public/forms/{org_id}/{form_id}/embed/ |
GET |
/api/public/forms/{org_id}/{form_id}/submit/ |
POST |
/api/public/invoice/{token}/ |
GET |
/api/public/invoice/{token}/pdf/ |
GET |
/api/search/ |
GET |
/api/tags/ |
GET, POST |
/api/tags/{id}/ |
DELETE, GET, PUT |
/api/tags/{id}/merge/ |
POST |
/api/tags/{id}/restore/ |
POST |
/api/tasks/ |
GET, POST |
/api/tasks/attachment/{id}/ |
DELETE |
/api/tasks/comment/{id}/ |
DELETE, PATCH, PUT |
/api/tasks/kanban/ |
GET |
/api/tasks/pipelines/ |
GET, POST |
/api/tasks/pipelines/{id}/ |
DELETE, GET, PUT |
/api/tasks/pipelines/{pipeline_pk}/stages/ |
POST |
/api/tasks/pipelines/{pipeline_pk}/stages/reorder/ |
POST |
/api/tasks/stages/{id}/ |
DELETE, PUT |
/api/tasks/{id}/ |
DELETE, GET, PATCH, POST, PUT |
/api/tasks/{id}/move/ |
PATCH |
/api/teams/ |
GET, POST |
/api/teams/{id}/ |
DELETE, GET, PATCH, PUT |
/api/time-entries/report/ |
GET |
/api/time-entries/report/export/ |
GET |
/api/time-entries/timesheet/ |
GET |
/api/time-entries/unbilled/ |
GET |
/api/time-entries/{id}/ |
DELETE, PUT |
/api/time-entries/{id}/stop/ |
POST |
/api/user/{id}/ |
DELETE, GET, PATCH, PUT |
/api/user/{id}/status/ |
POST |
/api/users/ |
GET, POST |
/api/users/get-teams-and-users/ |
GET |
/api/webforms/ |
GET, POST |
/api/webforms/{id}/ |
DELETE, GET, PUT |
/api/webforms/{id}/analytics/ |
GET |
/api/webforms/{id}/publish/ |
POST |
/api/webforms/{id}/submissions/ |
GET |
/api/webforms/{id}/unpublish/ |
POST |