v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

EMPLOYEES

Get all employees

Retrieves information about employees associated with a merchant.

get/v3/merchants/{mId}/employees

mIdstring required

Merchant identifier (mId).

filterstring

Filter fields to display search results: [modifiedTime, role, role.id, customId, name, nickname, id, deletedTime, deleted_time, email]

expandstring

Expandable fields to display additional nested information: [roles, shifts]

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 employees for a merchant.

idstring

Employee identifier.

namestring required

Employee's full name.

nicknamestring

Employee's nick name.

customIdstring

Custom identifier (ID) of the employee.

emailstring

Employee's email address.

inviteSentboolean

Indicates whether an invite was sent to the employee to activate their account.

claimedTimeinteger

Time when the employee claimed their account.

deletedTimeinteger

Time when the employee account was deleted.

pinstring

Employee’s personal identification number (hashed PIN).

unhashedPinstring

Employee’s personal identification number (unhashed PIN).

role'ADMIN' | 'MANAGER' | 'EMPLOYEE'

Employee role, for example: admin, manager, and employee.

isOwnerboolean

Indicates whether the employee has an Owner role for the merchant account.