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
Firm
Get firm
Retrieves the details of the firm associated with the authenticated client.
GET
/
firm
curl --request GET \
--url https://api.smokeball.com/firm \
--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": "f4ff1eff-b7fe-4d46-4e46-01d985838d76",
"versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
"owner": "Smokeball",
"name": "Brown LLC",
"status": {
"status": "Active",
"statusMessage": "<string>"
},
"productId": "SMK001",
"addOnIds": [
"ADD01",
"ADD003"
],
"email": "john.smith@law.com",
"abn": "1234567890",
"acn": "1234567890",
"streetAddress": {
"buildingLevel": "Level 1",
"unitNumber": "10",
"unitType": "Suite",
"streetNumber": "100",
"streetName": "Broad",
"streetType": "Street",
"addressLine1": "Level 1/10",
"addressLine2": "100 Broad Street",
"city": "Chicago",
"state": "IL",
"zipCode": "60606",
"county": "Berkshire",
"locality": "Windsor",
"country": "United States",
"careOf": "",
"poBoxType": "",
"poBoxNumber": ""
},
"mailingAddress": {
"buildingLevel": "Level 1",
"unitNumber": "10",
"unitType": "Suite",
"streetNumber": "100",
"streetName": "Broad",
"streetType": "Street",
"addressLine1": "Level 1/10",
"addressLine2": "100 Broad Street",
"city": "Chicago",
"state": "IL",
"zipCode": "60606",
"county": "Berkshire",
"locality": "Windsor",
"country": "United States",
"careOf": "",
"poBoxType": "",
"poBoxNumber": ""
},
"dxAddress": {
"number": "376",
"exchange": "DX",
"state": "NSW"
},
"phone": {
"areaCode": "555",
"number": "1234567"
},
"fax": {
"areaCode": "555",
"number": "1234567"
},
"logo": "https://example-logo-url.com/image",
"stylingDetails": {
"primaryColorHexCode": "#FF000000",
"secondaryColorHexCode": "#FF000000",
"fontFamilyName": "Open Sans"
},
"licenceNumbers": [
{
"state": "IL",
"type": "",
"number": "<string>"
}
]
}
Response
200
application/json
When request is successful. Returns a 'Firm' object.
The response is of type object
.
curl --request GET \
--url https://api.smokeball.com/firm \
--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": "f4ff1eff-b7fe-4d46-4e46-01d985838d76",
"versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
"owner": "Smokeball",
"name": "Brown LLC",
"status": {
"status": "Active",
"statusMessage": "<string>"
},
"productId": "SMK001",
"addOnIds": [
"ADD01",
"ADD003"
],
"email": "john.smith@law.com",
"abn": "1234567890",
"acn": "1234567890",
"streetAddress": {
"buildingLevel": "Level 1",
"unitNumber": "10",
"unitType": "Suite",
"streetNumber": "100",
"streetName": "Broad",
"streetType": "Street",
"addressLine1": "Level 1/10",
"addressLine2": "100 Broad Street",
"city": "Chicago",
"state": "IL",
"zipCode": "60606",
"county": "Berkshire",
"locality": "Windsor",
"country": "United States",
"careOf": "",
"poBoxType": "",
"poBoxNumber": ""
},
"mailingAddress": {
"buildingLevel": "Level 1",
"unitNumber": "10",
"unitType": "Suite",
"streetNumber": "100",
"streetName": "Broad",
"streetType": "Street",
"addressLine1": "Level 1/10",
"addressLine2": "100 Broad Street",
"city": "Chicago",
"state": "IL",
"zipCode": "60606",
"county": "Berkshire",
"locality": "Windsor",
"country": "United States",
"careOf": "",
"poBoxType": "",
"poBoxNumber": ""
},
"dxAddress": {
"number": "376",
"exchange": "DX",
"state": "NSW"
},
"phone": {
"areaCode": "555",
"number": "1234567"
},
"fax": {
"areaCode": "555",
"number": "1234567"
},
"logo": "https://example-logo-url.com/image",
"stylingDetails": {
"primaryColorHexCode": "#FF000000",
"secondaryColorHexCode": "#FF000000",
"fontFamilyName": "Open Sans"
},
"licenceNumbers": [
{
"state": "IL",
"type": "",
"number": "<string>"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.