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

List the users a service order can be assigned to

List the users of the tenant a service order at this store can be assigned to: exactly the users post-serviceorders-assign accepts as assignedUserUid at this store, so the picker and the assign never disagree. The store in the path is the store that owns the service order, as it is on the assign. Each item's tenantUserUid is the value assignedUserUid takes on post-serviceorders-assign. A user is listed when they can log in, are not an integration account, and hold SERVICE_ORDER reaching this store — granted at the store, at its organization, or tenant-wide, the three adding up rather than the narrowest deciding, and a tenant-wide ADMIN grant counting as every permission; an ADMIN permission held at an organization or a store is not every permission there. The legacy tenant role grants nothing here, so a user with no role assignments is not listed. A deactivated user is left out; the tenant role is not read, so a blocked user is left out because blocking them through the user update deactivates them. A user whose e-mail invitation is not yet accepted is listed, because the assign accepts them. Who is asking changes nothing for a user of the tenant: a superadmin caller who is a user of the tenant gets the same list as anyone, and a superadmin is listed only on the grants they hold as a user of the tenant. A superadmin caller who is not a user of the tenant is refused with a 403. query narrows the list. It is matched case-insensitively and in part against the display name, the first name, the last name and the user code. E-mail and mobile are not matched, because the list never shows them. An empty or missing query lists everyone who can be assigned. The list is sorted by display name, with the tenantUserUid as the tiebreaker, and is paged, the paging counting the users who can be assigned; there is no sort parameter. Each item carries the user's uid and display name only — never the user's permissions, e-mail or mobile. A caller who does not hold SERVICE_ORDER at the store in the path is refused with a 403, and a storeUid naming no store of the tenant with a 400.

Required permissions: SERVICE_ORDER

get
/tenants/{tenantUid}/stores/{storeUid}/serviceorders/assignees
Authorizations
AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
storeUidstringRequired

Reference to a Store.

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

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

querystringOptional

Narrows the list of users a service order can be assigned to. Matched case-insensitively and in part against the display name, the first name, the last name and the user code. E-mail and mobile are not matched, because the list never shows them. An empty or missing query lists everyone who can be assigned.

Responses
200

Example response

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

Example response

{
  "items": [
    {
      "tenantUserUid": "text",
      "displayName": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Last updated

Was this helpful?