cURL
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": "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": "[email protected]", "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" } } ], "offset": 123, "limit": 123, "size": 123, "first": { "id": "<string>", "href": "<string>", "relation": "<string>", "method": "GET" }, "previous": { "id": "<string>", "href": "<string>", "relation": "<string>", "method": "GET" }, "next": { "id": "<string>", "href": "<string>", "relation": "<string>", "method": "GET" }, "last": { "id": "<string>", "href": "<string>", "relation": "<string>", "method": "GET" } }
Retrieves a paginated list of staff members (filtered based on search parameters provided) in the firm associated with the authenticated client.
Available fields: email, name
Available fields: rate
When request is successful. Returns a paged collection of 'Staff' objects.
Show child attributes