GET
/
staff
/
{id}
Get firm staff member
curl --request GET \
  --url https://api.smokeball.com/staff/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "title": "Mr",
  "firstName": "John",
  "middleName": "",
  "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",
  "former": false,
  "enabled": true,
  "userId": "14b5dd57-3681-420e-a483-4823424eef45",
  "colorFill": "#797d85",
  "colorStroke": "#64666a",
  "licenceNumbers": [
    {
      "state": "IL",
      "type": "",
      "number": "<string>"
    }
  ],
  "outOfOffice": {
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
id
string
required

Response

When request is successful. Returns a 'Staff' object

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the staff member.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

​
versionId
string | null

Version id of the record.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

​
title
string | null

Staff member's title.

Example:

"Mr"

​
firstName
string | null

Staff member's first name.

Example:

"John"

​
middleName
string | null

Staff member's middle name (if applicable).

Example:

""

​
lastName
string | null

Staff member's last name.

Example:

"Smith"

​
initials
string | null

Staff member's initials.

Example:

"JS"

​
phone
object

Staff member's phone details.

​
cell
object

Staff member's mobile details.

​
email
string | null

Staff member's email address.

Example:

"john.smith@brown.com"

​
role
string | null

Staff member's role.

Example:

"Bookkeeper"

​
rate
number | null

Staff member's hourly rate in dollars.

Example:

150

​
avatar
string | null

Staff member's avatar.

Example:

"https://example-avatar-url.com/image"

​
former
boolean

Whether he/she is a former member.

Example:

false

​
enabled
boolean

Whether staff member is enabled.

Example:

true

​
userId
string | null

Staff member's User Id, if enabled.

Example:

"14b5dd57-3681-420e-a483-4823424eef45"

​
colorFill
string | null

Staff member's fill color hex code.

Example:

"#797d85"

​
colorStroke
string | null

Staff member's stroke color hex code.

Example:

"#64666a"

​
licenceNumbers
object[] | null

Licence numbers of the staff member.

​
outOfOffice
object

Staff member's Out-of-office period, if enabled.