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}

Get firm staff member

cURL

curl --request GET \
  --url https://api.smokeball.com/staff/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.smokeball.com/staff/{id}"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

fetch('https://api.smokeball.com/staff/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/staff/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/staff/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smokeball.com/staff/{id}")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/staff/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "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": "[e-mail]",
  "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"
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

id · string · required

Response

200

application/json

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

href · string | null

relation · string | null

method · string | null · default: GET

self · object | null

Show child attributes

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 | null

Staff member's phone details.

Show child attributes

cell · object | null

Staff member's mobile details.

Show child attributes

email · string | null

Staff member's email address.

Example:

"[e-mail]"

role · string | null

Staff member's role.

Example:

"Bookkeeper"

rate · number<double> | 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.

Show child attributes

outOfOffice · object | null

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

Show child attributes