GET
/
staff
curl --request GET \
  --url https://api.smokeball.com/staff \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "value": [
    {
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "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>"
        }
      ]
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  }
}

Authorizations

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

Query Parameters

Available fields: email, name

Fields
string

Available fields: rate

Response

200 - application/json

When request is successful. Returns a paged collection of 'Staff' objects

The response is of type object.