v1

latestOpenAPI 3.0.12026-07-13139143370.4 KB
BusinessUsers

List Users

Use this endpoint to return a List of Business Users and their Roles. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

get/setup/v1/businessusers

Query parameters

locationIdstring

id of business location, defaults to primary business location

emailstring

Filter by email address

rolestring

Filter user role

offsetinteger

Starting row of page, default 0

limitinteger

Page limit default 20, max 100

Response

Success

objectstring nullable
urlstring nullable
hasMoreboolean
countinteger
totalinteger