Path parameters

• businessLocationId integer(int64) Required

  Unique identifier for a business location.

Query parameters

• page integer(int32)

  The page number, when paginating.

  Minimum value is 1. Default value is 1.

• size integer(int32)

  Number of results to return per page, when paginating.

  Minimum value is 1. Default value is 10.

• sort array[string]

  Sort by field and direction.

  Default value is ["userId,desc"].

• email string(email)

  Filter on email address.

• isActive boolean

  Filter on active status.

• startDate string(date-time)

  Filter on employee start date.

• endDate string(date-time)

  Filter on employee end date.

Responses

• 200 application/json

  Staff List

  Hide response attributes Show response attributes object

  • data object
    Hide data attribute Show data attribute

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

      • staffId integer(int64)

        Unique identifier for an employee.

      • 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)

        E-mail address of the employee. 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.

  • links object
    Hide links attributes Show links attributes

    • first object
      Hide first attribute Show first attribute

      • href string(uri)
    • self object
      Hide self attribute Show self attribute

      • href string(uri)
    • next object
      Hide next attribute Show next attribute

      • href string(uri)
    • last object
      Hide last attribute Show last attribute

      • href string(uri)
  • page object
    Hide page attributes Show page attributes

    • page integer

      Current page number.

    • size integer

      Number of elements in the page.

    • totalElements integer

      Total number of elements.

    • totalPages integer

      Total number of pages of results.