Authentication

Returns information on user who authorized connection

get/userinfo

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/userinfo
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code

Query parameters

property_idstring

Property to resolve role_details for. When the user holds both an Organization-level role and a Property-level role for this property, both are returned in roles and acl is the union of their permissions (an "allow" in either role wins). Takes precedence over organization_id when both are supplied.

organization_idstring

Organization to resolve role_details for (alternative to property_id). Returns the user's Organization-level role for that organization and its permissions.

role_detailsboolean

Specify whether to include role and acl details of the user.

Response

200 Response

user_idstring

ID of user

first_namestring

Authorized users' first name.

last_namestring

Authorized users' last name.

emailstring

Authorized users' email.

aclstring[] nullable

Authorized users' access control list.

Changes