Service report settings API
REST endpoints for service report settings in ServFlo: 2 operations with parameters, request and response fields, permissions and curl examples.
Base URL: https://app.servflo.ai/api. Every call needs Authorization: Bearer sfk_… (Authentication); {organizationId} ($ORGANIZATION_ID in the examples) is your business's id.
| Operation | Endpoint | Risk |
|---|---|---|
| Service report release rules | GET /organizations/{organizationId}/service-report-release-rules | read |
| Set a service report release rule | PATCH /organizations/{organizationId}/service-report-release-rules | sensitive |
Service report release rules
GET /organizations/{organizationId}/service-report-release-rules
When published reports open for the client: the business's default and each service type's own rule (IMMEDIATE, ON_PAID, ON_AGREEMENT, ON_PAID_AND_AGREEMENT; a manual review; what agents see). Read-only.
| Permission | serviceReports.read (Owner, Admin, Dispatcher, Technician, Member) |
| Risk | read, OAuth scope servflo.read. Read: reads only. |
| MCP tool | serviceReportSettings_releaseRules (toolset serviceReports) |
Example
curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/service-report-release-rules" \
-H "Authorization: Bearer $SERVFLO_API_KEY"Response
200: the answer's fields
| Field | Type | Description |
|---|---|---|
default | object | For service types without their own rule. |
default.mode | enum | One of IMMEDIATE, ON_PAID, ON_AGREEMENT, ON_PAID_AND_AGREEMENT. |
default.requireManualReview | boolean | |
default.agentView | enum | One of FULL, SUMMARY, NONE. |
defaultIsSet | boolean | False: the trade's default (inspections: paid and signed; others: immediate). |
byServiceType | array of object | |
byServiceType[].serviceTypeId | string | |
byServiceType[].mode | enum | One of IMMEDIATE, ON_PAID, ON_AGREEMENT, ON_PAID_AND_AGREEMENT. |
byServiceType[].requireManualReview | boolean | |
byServiceType[].agentView | enum | One of FULL, SUMMARY, NONE. |
Set a service report release rule
PATCH /organizations/{organizationId}/service-report-release-rules
EXPOSES TO CUSTOMERS when loosened: sets the default (no serviceTypeId) or one service type's rule; reset: true removes a service type's own rule. Published, still-locked reports are re-checked and may open now (their clients are then sent the link). Returns the rules.
| Permission | serviceReports.manage (Owner, Admin) |
| Risk | sensitive, OAuth scope servflo.sensitive. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access. |
| MCP tool | serviceReportSettings_setReleaseRule (toolset serviceReports) |
| Approval | Over MCP, this tool asks for your OK first (in the AI app when it supports it, otherwise in ServFlo). See Approvals. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
serviceTypeId | string or null | No | |
reset | boolean | No | |
mode | enum | No | One of IMMEDIATE, ON_PAID, ON_AGREEMENT, ON_PAID_AND_AGREEMENT. |
requireManualReview | boolean | No | Wait for staff to unlock each report. |
agentView | enum | No | One of FULL, SUMMARY, NONE. |
Example
curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/service-report-release-rules" \
-H "Authorization: Bearer $SERVFLO_API_KEY" \
-H "Content-Type: application/json" \
-d '{"serviceTypeId":"serviceType_id","reset":true,"mode":"IMMEDIATE"}'Response
200: the answer's fields
| Field | Type | Description |
|---|---|---|
default | object | For service types without their own rule. |
default.mode | enum | One of IMMEDIATE, ON_PAID, ON_AGREEMENT, ON_PAID_AND_AGREEMENT. |
default.requireManualReview | boolean | |
default.agentView | enum | One of FULL, SUMMARY, NONE. |
defaultIsSet | boolean | False: the trade's default (inspections: paid and signed; others: immediate). |
byServiceType | array of object | |
byServiceType[].serviceTypeId | string | |
byServiceType[].mode | enum | One of IMMEDIATE, ON_PAID, ON_AGREEMENT, ON_PAID_AND_AGREEMENT. |
byServiceType[].requireManualReview | boolean | |
byServiceType[].agentView | enum | One of FULL, SUMMARY, NONE. |
Service report templates API
REST endpoints for service report templates in ServFlo: 37 operations with parameters, request and response fields, permissions and curl examples.
Agreement templates API
REST endpoints for agreement templates in ServFlo: 5 operations with parameters, request and response fields, permissions and curl examples.