API Reference
Documentation API Reference API Status Matrix Current shipped, documented, beta, and deprecated status for Workestra API routes.
This page is generated from the current workestra-app/src/app/api/v1 route tree. It is a launch-status matrix, not a complete endpoint reference.
Status Meaning Shipped Route exists under /api/v1 and is part of the current app route tree. Deprecated Route exists only for legacy compatibility or is explicitly discouraged. Internal Route is not under /api/v1; do not use it as a public API contract. Not present No current app route was found.
Documentation coverage is tracked separately:
Coverage Meaning Guide A dedicated endpoint guide exists in these docs. Matrix The route is listed here but does not yet have a full endpoint guide. Legacy note The route family is documented only to redirect developers away from old endpoints.
https://workestra.app/api/v1 Use API keys with the wks_ prefix for REST integrations. See Authentication .
Metric Count Current /api/v1 route files 87 Route files listed in this matrix 87 Dedicated endpoint-guide families CRM contacts, CRM deals, issues, projects Legacy Supabase function families Deprecated; do not use for new integrations
Route Methods Status Coverage Notes /auth/loginPOSTShipped Matrix API login helper; most third-party integrations should use API keys instead of password login.
Route Methods Status Coverage Notes /crm/contactsGET, POSTShipped Guide List and create contacts. /crm/companiesGET, POSTShipped Matrix Company list/create. /crm/companies/{id}GET, PATCH, DELETEShipped Matrix Company detail/update/delete. /crm/dealsGET, POSTShipped Guide List and create deals. /crm/deals/{id}GET, PATCH, DELETEShipped Guide Deal detail/update/delete. /crm/activitiesGET, POSTShipped Matrix Activity list/create. /crm/activities/{id}GET, PATCH, DELETEShipped Matrix Activity detail/update/delete.
Route Methods Status Coverage Notes /projectsGET, POSTShipped Guide List and create projects. /projects/{id}GET, PATCH, DELETEShipped Guide Project detail/update/delete. /projects/{id}/cyclesGET, POSTShipped Matrix Project cycle list/create. /projects/{id}/issuesGETShipped Matrix Project-scoped issue list. /issuesGET, POSTShipped Guide List and create issues. /issues/{id}GET, PATCH, DELETEShipped Guide Issue detail/update/delete. /issues/{id}/commentsGET, POSTShipped Matrix Issue comments. /issues/bulk-updatePOSTShipped Matrix Bulk issue update action.
Route Methods Status Coverage Notes /planning/allocationsGET, POSTShipped Matrix Resource allocations. /planning/allocations/{id}GET, PATCH, DELETEShipped Matrix Allocation detail/update/delete. /planning/role-placeholdersGET, POSTShipped Matrix Role placeholder list/create. /planning/role-placeholders/{id}GET, PATCH, DELETEShipped Matrix Role placeholder detail/update/delete. /planning/skillsGET, POSTShipped Matrix Planning skills. /planning/skills/{id}GET, PATCH, DELETEShipped Matrix Skill detail/update/delete. /planning/capacityGETShipped Matrix Capacity reporting. /planning/conflictsGETShipped Matrix Allocation conflict reporting. /planning/utilizationGETShipped Matrix Utilization reporting.
Route Methods Status Coverage Notes /time-entriesGET, POSTShipped Matrix Time entry list/create. /time-entries/{id}GET, PATCH, DELETEShipped Matrix Time entry detail/update/delete. /timesheetsGETShipped Matrix Timesheet list. /timesheets/{id}GET, PATCHShipped Matrix Timesheet detail/update. /timesheets/{id}/submitPOSTShipped Matrix Submit timesheet. /timesheets/{id}/approvePOSTShipped Matrix Approve timesheet. /timesheets/{id}/rejectPOSTShipped Matrix Reject timesheet. /time/settingsGET, PATCHShipped Matrix Time module settings. /time/ratesGET, POSTShipped Matrix Billing/time rates. /time/rates/{id}DELETEShipped Matrix Delete a rate. /time/reports/summaryGETShipped Matrix Time summary report. /time/timer/activeGETShipped Matrix Active timer. /time/timer/startPOSTShipped Matrix Start timer. /time/timer/stopPOSTShipped Matrix Stop timer. /time/webhooksGET, POSTShipped Matrix Time webhook subscriptions. /time/webhooks/{id}DELETEShipped Matrix Delete a time webhook.
Route Methods Status Coverage Notes /assetsGET, POSTShipped Matrix Asset list/create. /assets/{id}GET, PATCH, DELETEShipped Matrix Asset detail/update/delete. /assets/portfolioGETShipped Matrix Asset portfolio view. /asset-assignmentsGET, POSTShipped Matrix Asset assignments. /asset-assignments/{id}GET, PATCH, DELETEShipped Matrix Assignment detail/update/delete. /asset-reservationsGET, POSTShipped Matrix Asset reservations. /asset-reservations/{id}GET, PATCH, DELETEShipped Matrix Reservation detail/update/delete. /asset-maintenanceGET, POSTShipped Matrix Asset maintenance list/create. /asset-maintenance/{id}GETShipped Matrix Maintenance detail.
Route Methods Status Coverage Notes /stock/productsGET, POSTShipped Matrix Stock products. /stock/warehousesGET, POSTShipped Matrix Warehouses. /stock/movementsGET, POSTShipped Matrix Stock movements.
Route Methods Status Coverage Notes /booking-linksGET, POSTShipped Matrix Booking link list/create. /booking-links/{id}GET, PATCH, DELETEShipped Matrix Booking link detail/update/delete. /bookingsGET, POSTShipped Matrix Booking list/create. /bookings/{id}GET, PATCH, DELETEShipped Matrix Booking detail/update/delete.
Route Methods Status Coverage Notes /fsm/work-ordersGET, POSTShipped Matrix Work order list/create. /fsm/work-orders/{id}GET, PATCH, DELETEShipped Matrix Work order detail/update/delete. /fsm/techniciansGET, POSTShipped Matrix Technician list/create. /fsm/service-contractsGET, POSTShipped Matrix Service contract list/create. /fsm/service-contracts/{id}GET, PATCHShipped Matrix Service contract detail/update.
Route Methods Status Coverage Notes /procurement/vendorsGET, POSTShipped Matrix Vendor list/create. /procurement/vendors/{id}GET, PATCH, DELETEShipped Matrix Vendor detail/update/delete. /procurement/purchase-ordersGET, POSTShipped Matrix Purchase order list/create. /procurement/purchase-orders/{id}GETShipped Matrix Purchase order detail.
Route Methods Status Coverage Notes /surveysGET, POSTShipped Matrix Survey list/create. /surveys/{id}GET, PATCH, DELETEShipped Matrix Survey detail/update/delete. /surveys/{id}/responsesGETShipped Matrix Survey responses. /surveys/{id}/responses/submitPOSTShipped Matrix Public response submission route.
Route Methods Status Coverage Notes /goalsGET, POSTShipped Matrix Goal list/create. /goals/{id}GET, PATCH, DELETEShipped Matrix Goal detail/update/delete. /goals/{id}/contributionsGET, POSTShipped Matrix Goal contributions. /goals/cyclesGET, POSTShipped Matrix Goal cycles. /goals/cycles/{id}GET, PATCHShipped Matrix Goal cycle detail/update.
Route Methods Status Coverage Notes /marketing/campaignsGET, POSTShipped Matrix Campaign list/create. /marketing/campaigns/{id}GET, PATCHShipped Matrix Campaign detail/update. /marketing/segmentsGET, POSTShipped Matrix Segment list/create. /marketing/segments/{id}GET, POSTShipped Matrix Segment detail/actions. /marketing/sendsGETShipped Matrix Campaign send records. /marketing/templatesGET, POSTShipped Matrix Template list/create. /marketing/templates/{id}GETShipped Matrix Template detail.
Route Methods Status Coverage Notes /subscriptions/plansGET, POSTShipped Matrix Plan list/create. /subscriptions/plans/{id}GET, PATCHShipped Matrix Plan detail/update. /subscriptions/subscriptionsGET, POSTShipped Matrix Subscription list/create. /subscriptions/subscriptions/{id}GET, PATCHShipped Matrix Subscription detail/update. /subscriptions/dunning-eventsGETShipped Matrix Dunning event list.
Older Supabase Edge Function paths are deprecated and should not be used for new integrations:
Legacy family Status Replacement /api-contactsDeprecated /api/v1/crm/contacts/api-dealsDeprecated /api/v1/crm/deals/api-issuesDeprecated /api/v1/issues/api-projectsDeprecated /api/v1/projects/api-ingestDeprecated Resource-specific /api/v1 endpoints
Routes outside /api/v1 are not covered by this public REST status matrix. Examples include app admin routes, cron routes, inbound provider webhooks, portal routes, legal routes, and console/operator routes.
Do not build public integrations against non-v1 paths unless a Workestra integration guide explicitly says to do so.
When adding, removing, or renaming a /api/v1 route:
Update this matrix in the same change.
Add a dedicated endpoint guide when the route becomes a supported developer-facing contract.
Mark legacy paths as deprecated before removing docs references.
Keep the app-owned OpenAPI endpoint aligned with the route tree.
The OpenAPI regeneration/status-coverage task is tracked separately from this matrix.