Sign in
Staff

Retrieves the staff and user details for the specified firm

get/api/firms/firm-staff/{firmId}

Request

  • Base URL: https://uk-api.leap.services
  • URL: https://uk-api.leap.services/api/firms/firm-staff/{firmId}
  • Auth: one of:
    • API key in header Authorization
    • API key in header x-api-key

Path parameters

firmIdstring required

Query parameters

ignoreInvalidStaffstring

Headers

Authorizationstring required

Auth Token

Response

200 response

userIdstring uuid
externalUserIdstring
userNamestring
passwordstring
deleteCodeinteger
userTypeinteger
userStatusinteger
staffIdstring uuid
firmIdstring uuid
branchIdstring uuid
titlestring
firstNamestring
lastNamestring
middleNamestring
faxstring
phonestring
mobilestring
immigrationLicensestring
practisingCertificatestring
qualificationstring
rate1number double
rate2number double
rate3number double
rate4number double
rate5number double
rate6number double
showInStaffListboolean
initialsstring
emailstring
enableLoginboolean
expiredAtUtcstring date-time
mfaEnforcedboolean
mfaFirmStatusinteger
isRapidPayNotificationEnabledboolean
lastAccessstring date-time
autoTimeboolean
rolestring
legacyStaffIdstring
powerBIEnabledboolean
isAIStaffboolean

Changes

No recorded changes to this operation across all 1 revision of this API.