atlas

List user roles with search filters

List user roles with search filters: returning lighthouse users with optional filters including 1. merchant ID; merchantId parameter 2. user email (partial); query parameter 3. role type id; roleTypeId_in parameter

get/atlas/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/atlas/v1/user-roles
  • Auth: OAuth 2 (implicit, authorization URL "")

Query parameters

merchantIdstring

filters on user roles whose merchantId is equal to this value

querystring

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

roleType_instring[]

filter on user roles whose roleType is in one of the provided values

offsetinteger

offset

limitinteger

limit

Response

success

totalCountinteger

Changes

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