v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

MERCHANTS

Get all roles for a merchant

Retrieves all system and employee roles for a merchant's business.

get/v3/merchants/{mId}/roles

mIdstring required

Merchant identifier.

filterstring

Filter fields to display search results: [modifiedTime, systemRole, name, id, deletedTime]

expandstring

Expandable fields to display additional nested information: [employees]

offsetinteger

Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

limitinteger

Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Successful response. Displays all roles for the merchant.

idstring

Unique identifier of the role.

namestring required

Full name of the role.

systemRole'OWNER' | 'ADMIN' | 'MANAGER' | 'EMPLOYEE' required

Base system role, such as Owner, Admin, Manager, or Employee.