Users

Retrieve User Roles

Use this endpoint to retrieve all the Roles a User has.

get/users/{userId}/site-roles

Response

Roles were successfully retrieved.

Example response

{
  "data": [
    {
      "permissions": [
        "users.view"
      ],
      "role": {
        "id": "beddda88-947d-4bd8-8f0c-828b187f93b2",
        "name": "Therapist",
        "description": "Therapists have read-only access to the system. This should be used to give users basic access to clients and reservations.",
        "organisation_id": "beddda88-947d-4bd8-8f0c-828b187f93b2"
      },
      "site": {
        "id": "00000000-0000-0000-0000-111111111111",
        "name": "Top Spa",
        "frontend_subdomain": "topspa",
        "currency": "gbp",
        "timezone": "Europe/London",
        "locale": "en",
        "country_code": "GB",
        "external_id": "GBSPA1",
        "organisation_id": "00000000-0000-0000-0000-000000000000",
        "organisation_name": "Palm Tree Group Ltd.",
        "is_read_only": true,
        "created_at": "2023-05-24 12:00:00"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.