Path parameters

• businessLocationId integer(int64) Required

  Unique identifier for a business location.

• staffId integer(int64) Required

  Unique identifier for an employee.

Responses

• 200 application/json

  Staff object

  Hide response attributes Show response attributes object

  • staffId integer(int64)

    Unique identifier for an employee.

  • username string

    Only used for POS staff

    Maximum length is 128.

  • userTypes array[string]

    Values are POS, BACK_OFFICE, or API.

  • firstName string

    First name of the employee.

    Maximum length is 128.

  • lastName string

    Last name of the employee.

    Maximum length is 128.

  • email string(email)

    Only used for Back Office staff

    Maximum length is 128.

  • active boolean

    Whether the employee is active.

  • createdOn string(date-time)

    Timestamp of the creation of the employee.

  • modifiedOn string(date-time)

    Timestamp of the last update to the employee.

  • businessId integer(int64)

    The unique identifier of the business.

  • businessLocationId integer(int64)

    The unique identifier of the business location.

  • groups array[object]
    Hide groups attributes Show groups attributes object

    • id integer(int64)

      Unique identifier for an employee group.

    • name string

      Name of the employee group.

  • reportAccess array[string]

    Employee report permissions.

  • roles array[object]
    Hide roles attributes Show roles attributes object

    • id integer(int64)

      Unique identifier for a role.

    • name string

      Name of the role.