lighthouse

Query user roles for specified merchant

Query user roles for specified merchant; returning members in the merchant with optional filters including 1. user email (partial); query parameter 2. role id; roleId parameter

get/lighthouse/v1/user-roles

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/lighthouse/v1/user-roles
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

querystring

Filter users with string comparison logic on users' email. This is what users type in the search box in Settings/Members page.

roleIdstring

roleId; only users assigned to this role will be returned

roleId_instring[]

filters on user roles whose roleId matches one of the provided values

offsetinteger

offset; starts at 0

limitinteger

limit

Headers

x-beam-merchant-idstring required

x-beam-merchant-id

Response

success

totalCountinteger

TotalCount is the number of matched rows fetched from query before pagination logic

Changes

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