curl --request GET \
--url https://api.smokeball.com/firm \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.smokeball.com/firm"
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/firm', 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/firm",
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/firm"
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/firm")
.header("x-api-key", "<api-key>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smokeball.com/firm")
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{
"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": [
"ADD001",
"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>"
}
],
"createdDate": "2024-01-15T10:30:00Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Get firm
Retrieves the details of the firm associated with the authenticated client.
curl --request GET \
--url https://api.smokeball.com/firm \
--header 'Authorization: <api-key>' \
--header 'x-api-key: <api-key>'import requests
url = "https://api.smokeball.com/firm"
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/firm', 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/firm",
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/firm"
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/firm")
.header("x-api-key", "<api-key>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smokeball.com/firm")
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{
"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": [
"ADD001",
"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>"
}
],
"createdDate": "2024-01-15T10:30:00Z"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Response
When request is successful. Returns a 'Firm' object.
Show child attributes
Show child attributes
Unique identifier of the firm.
"f4ff1eff-b7fe-4d46-4e46-01d985838d76"
Version id of the record.
"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"
The owner/white-label partner used by the firm.
Possible values: Smokeball, PracticeEvolve, TriConvey.
"Smokeball"
The name of the firm.
"Brown LLC"
The status of the firm.
Show child attributes
Show child attributes
The product/tier the firm is subscribed to. Must be set when creating the firm and is optional when updating the firm.
The supported products are listed in order below, the identifier (in brackets) must be used.
-
Bill (SMK001)
-
Boost (SMK004)
-
Grow (SMK002)
-
Prosper + (SMK003)
Possible values: SMK001, SMK004, SMK002, SMK003
"SMK001"
The optional add-ons the firm is subscribed to. Must be specified with an accompanying productId.
The supported add-ons are listed below, the identifier (listed in brackets) must be used.
-
Intake (ADD001)
-
AutoTime (ADD003)
-
FamilyPro (ADD004)
-
Api (ADD005)
-
Workflows (ADD006)
-
PowerBI (ADD007)
-
Archie (ADD008)
-
SSO (ADD010)
-
PracticeEvolve (ADD011)
-
CustomReporting (ADD012)
Possible values: ADD001, ADD003, ADD004, ADD005, ADD006, ADD007, ADD008, ADD010, ADD011, ADD012
["ADD001", "ADD003"]
The email of the firm.
Only supported in AUS.
"john.smith@law.com"
For AU: Australian Business Number (ABN) of the firm.
For UK: Value-added Tax Number (VAT) of the firm.
Only supported in AU and UK.
"1234567890"
For AU: Australian Company Number (ACN) of the firm.
For UK: Company Registration Number (CRN) of the firm.
Only supported in AU and UK.
"1234567890"
Street address of the firm.
Show child attributes
Show child attributes
Mailing address of the firm.
Show child attributes
Show child attributes
DX address of the firm.
Only supported in AUS.
Show child attributes
Show child attributes
Phone number of the firm.
Show child attributes
Show child attributes
Fax number of the firm.
Show child attributes
Show child attributes
Logo of the firm.
"https://example-logo-url.com/image"
Styling details of the firm.
Show child attributes
Show child attributes
Licence numbers of the firm.
Show child attributes
Show child attributes
The date when the firm was created in UTC.
"2024-01-15T10:30:00Z"