Skip to main content

Approvals API

Endpoints

MethodEndpointDescription
GET/approvals/pending?page=&limit=Get pending approval requests
GET/approvals/requests/:requestIdGet single request
GET/approvals/entity/:entityType/:entityIdGet approvals for entity
POST/approvals/requests/:requestId/approveApprove with optional comment
POST/approvals/requests/:requestId/rejectReject with required comment
POST/approvals/requests/:requestId/cancelCancel request
GET/approvals/rulesList rules (optional ?entityType)
GET/approvals/rules/:ruleIdGet rule
POST/approvals/rulesCreate rule
PUT/approvals/rules/:ruleIdUpdate rule
DELETE/approvals/rules/:ruleIdDelete rule

Approval Rule

{
"id": "uuid",
"name": "Manager approval for large deals",
"entityType": "opportunities",
"triggerEvent": "close_won",
"conditions": {},
"isActive": true,
"priority": 1,
"steps": [
{ "stepOrder": 1, "approverType": "role", "approverRoleId": "uuid" },
{ "stepOrder": 2, "approverType": "user", "approverUserId": "uuid" }
]
}

Trigger Events

publish, close_won, discount_threshold, manual, project_created, project_completed, budget_exceeded

Entity Types

proposals, opportunities, deals, leads, projects, custom

Request Statuses

pending, approved, rejected, cancelled