BookMembers

Gets a single user's membership on a book, whether it comes from a system role, from application roles, or from both. `systemRole` is null when the user only holds application roles.

GET
/public-api/v1/books/{bookId}/members/users/{userId}
cURL
curl --request GET \
  --url '/public-api/v1/books/{bookId}/members/users/{userId}' \
  --header 'user-api-key: <api-key>'

Authorizations

  • user-api-keystringheader

    User's API Key · apiKey

Path parameters

  • bookIdstringrequired
  • userIdstringrequired

Responses

Member returned.

  • UserIdstringrequired

    The user.

  • SystemRolestring
  • Rolesobject[]

    Application roles held by the member, with their label.

    • RoleIdstringrequired

      Role identifier.

    • Labelstringrequired

      Display label.

    • Descriptionstring

      Optional description.