List panel users
get
https://api.flactrum.com/v1/users
What is listed is a membership: the same person can belong to several brands with different rights in each.
| Required scope | users.read |
| Panel screen | System → Users |
| Success status | 200 |
| Returns | A paginated list of BrandUser objects |
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| status | query | string | — |
| role_id | query | string | — |
| branch_id | query | string | — |
| query | string | — | |
| page | query | integer | Page number. |
| per_page | query | integer | Page size. Values above the maximum are rejected rather than silently clamped. |
| sort | query | string | Column to sort by. Each endpoint lists what it accepts. |
| direction | query | string | Sort direction. |
Response fields
| Field | Type | Description |
|---|---|---|
| id | string | Membership id — not the user id. |
| user_id | string | — |
| name | string|null | — |
| string|null | — | |
| role_id | string | — |
| role | string|null | Role slug. |
| branch_id | string|null | Set when the membership is scoped to one branch. |
| region | string|null | Set when scoped to a region. |
| branch_ids | array | Every branch the membership covers directly. |
| regions | array | Every region the membership covers. |
| scope | string | Derived from the branches and regions; the same value the invite input takes. scoped means more than one branch or region. |
| two_factor_required | boolean | This person must use two-factor authentication. |
| two_factor_enabled | boolean | Whether they have set it up. |
| invitation_url | string | Only in the response to an invite or resend, and only to the caller: the one-time acceptance link, so it can be passed on by hand if the e-mail does not arrive. Never stored or listed. |
| status | string | — |
| joined_at | string|null | — |
Examples
No recorded example yet.