v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Staff

Get firm staff member

Retrieves a staff member (based on staff id parameter provided) in the firm associated with the authenticated client.

get/staff/{id}

Path parameters

idstring required

Response

When request is successful. Returns a 'Staff' object.

hrefstring nullable

relationstring nullable

methodstring nullable

idstring nullable

Unique identifier of the staff member.

versionIdstring nullable

Version id of the record.

titlestring nullable

Staff member's title.

firstNamestring nullable

Staff member's first name.

middleNamestring nullable

Staff member's middle name (if applicable).

lastNamestring nullable

Staff member's last name.

initialsstring nullable

Staff member's initials.

emailstring nullable

Staff member's email address.

rolestring nullable

Staff member's role.

ratenumber double nullable

Staff member's hourly rate in dollars.

avatarstring nullable

Staff member's avatar.

formerboolean

Whether he/she is a former member.

enabledboolean

Whether staff member is enabled.

userIdstring nullable

Staff member's User Id, if enabled.

colorFillstring nullable

Staff member's fill color hex code.

colorStrokestring nullable

Staff member's stroke color hex code.

Example response

{
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "title": "Mr",
  "firstName": "John",
  "lastName": "Smith",
  "initials": "JS",
  "phone": {
    "areaCode": "555",
    "number": "1234567"
  },
  "cell": {
    "areaCode": "555",
    "number": "1234567"
  },
  "email": "john.smith@brown.com",
  "role": "Bookkeeper",
  "rate": 150,
  "avatar": "https://example-avatar-url.com/image",
  "enabled": true,
  "userId": "14b5dd57-3681-420e-a483-4823424eef45",
  "colorFill": "#797d85",
  "colorStroke": "#64666a",
  "licenceNumbers": [
    {
      "state": "IL"
    }
  ]
}