Documentation
- Getting Started
- Authentication
- Making Requests
- Resource Creation
- Searching
- Plugins
- Webhooks
Tutorials
APIs
- Activity Codes
- Archive
- Authorization
- Bank Accounts
- Contacts
- Events
- Expenses
- Fees
- Files
- Firm
- Firm Users
- Folders
- Invoices
- Layout Designs
- Layout Matter Items
- Matter Billing Configuration
- Matter Items
- Matter Types
- Matters
- Memos
- Notifications
- Plugins
- Referral Types
- Relationships
- Roles
- Staff
- Stages
- Subscription Payments
- Subscription Promotions
- Subscriptions
- Tasks
- Users
- Webhooks
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}
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>"
}
]
}
Path Parameters
Response
200
application/json
When request is successful. Returns a 'Staff' object
The response is of type object
.
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>"
}
]
}