For the complete documentation index, see llms.txt. This page is also available as Markdown.

List notifications for the caller

List the caller's own notifications, newest first — the inbox behind the bell in the service workspace. The inbox is personal: it is read as the caller and never returns anyone else's notifications. Set unreadOnly to read only the ones that have not been read yet. These are notifications to staff, inside Flow. They are not the messages Flow sends out to customers — those are SMS and e-mail, and are read through the notifications endpoints. A notification goes to the user the service order is assigned to. When a service order is not assigned to anyone it goes to the service staff of the store that owns it instead — the users holding a role that grants SERVICE_ORDER assigned at that store itself, not at its organization and not tenant-wide — so nothing is left waiting on a person who is not looking at it. Nobody is ever notified about their own action. There is no push delivery: poll this endpoint, and the unread count endpoint for the badge, every 30 to 60 seconds.

Required permissions: SERVICE_ORDER

get
/tenants/{tenantUid}/serviceorders/usernotifications
Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
unreadOnlybooleanOptional

Return only the notifications that have not been read yet. Defaults to false.

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

Responses
200

Example response

application/json
get/tenants/{tenantUid}/serviceorders/usernotifications
GET /v2/tenants/{tenantUid}/serviceorders/usernotifications HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "serviceUserNotificationUid": "text",
      "type": "ASSIGNED_TO_YOU",
      "serviceOrderUid": "text",
      "serviceEventUid": "text",
      "title": "text",
      "body": "text",
      "readAt": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Last updated

Was this helpful?