List service status message rules
List the rules that send the customer a message when a service order arrives at a status — the whole of what the tenant says to customers automatically, in one place. Pass serviceStatusUid to list only the rules on one status. Inactive rules are listed too: they are configured and switched off, not gone. Reading them asks for any service permission — SERVICE_ORDER or SERVICE_STORE_CONFIG at the tenant, at an organization or at any one store, or SERVICE_CONFIG, which is held at the tenant only — because whoever configures the status message rules reads them. A tenant-wide ADMIN grant counts as every permission. A caller holding none of them, a user with no role assignments included, is refused with a 403.
Required permissions: SERVICE_ORDER, SERVICE_STORE_CONFIG, SERVICE_CONFIG
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Filter by the service status the rule fires on
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Example response
GET /v2/tenants/{tenantUid}/serviceorders/statusrules HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"serviceStatusRuleUid": "text",
"tenantUid": "text",
"serviceStatusUid": "text",
"messageType": "EMAIL",
"templateType": "text",
"attachDocumentType": "INTAKE_CONFIRMATION",
"active": true,
"createdAt": "2026-01-01T00:00:00.000Z",
"createdBy": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastModifiedBy": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Last updated
Was this helpful?

