Skip to content

Ops Endpoints

All endpoints are prefixed with /api/v1/production/ops.

Customers

MethodPathDescription
GET/customersList all customers
GET/customers/:idFull workspace — customer + all operational data
POST/customers/:id/assignAssign agent to customer

Customer workspace response

GET /customers/:id returns a single object with all customer operational data:

{
"customer": { ... },
"orders": [...],
"policies": [...],
"timeline": [...],
"renewals": [...],
"communications": [...],
"tasks": [...],
"documents": [...],
"payments": [...],
"residency_applications": [...],
"work_permit_applications": [...],
"citizenship_applications": [...],
"real_estate_transactions": [...],
"turquoise_applications": [...]
}

Timeline

MethodPathDescription
GET/customers/:id/timeline?limit=100Customer timeline events
POST/customers/:id/timelineAdd a manual timeline event

Communications

MethodPathDescription
GET/customers/:id/communications?limit=100All communications
POST/customers/:id/communicationsLog a communication
POST/customers/:id/notesAdd internal note
PATCH/customers/:id/communications/readMark all as read

Tasks

MethodPathDescription
GET/tasksGlobal tasks queue
POST/tasksCreate a task
GET/customers/:id/tasksTasks for a customer
PUT/tasks/:task_idUpdate a task
PATCH/tasks/:task_id/completeComplete a task

Tasks queue parameters

ParameterTypeDescription
pagenumberPage number
limitnumberResults per page (default 50)
statusstringFilter by status
prioritystringFilter by priority
assignee_idstringFilter by assignee

Renewals

MethodPathDescription
GET/renewalsGlobal renewals queue
POST/renewals/refreshRun the renewals refresh (cron target)
GET/customers/:id/renewalsRenewals for a customer
POST/customers/:id/renewalsCreate a renewal
PATCH/renewals/:renewal_id/completeComplete a renewal

Renewals queue parameters

ParameterTypeDescription
days_windownumberLook-ahead window in days (default 90)
service_typestringFilter by service type
statusstringFilter by status

Policies

MethodPathDescription
GET/policiesGlobal policies list
GET/customers/:id/policiesPolicies for a customer
POST/customers/:id/policiesCreate a policy
PUT/policies/:policy_idUpdate a policy

Policies queue parameters

ParameterTypeDescription
pagenumberPage number
limitnumberResults per page
statusstringFilter by status

Documents

MethodPathDescription
GET/customers/:id/documentsDocuments for a customer
POST/customers/:id/documentsCreate a document record
PUT/documents/:doc_idUpdate document status / notes

Staff

MethodPathDescription
GET/staffList all staff members