GET
/
firm
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>"
    }
  ]
}

Authorizations

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

Response

When request is successful. Returns a 'Firm' object.

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the firm.

Example:

"f4ff1eff-b7fe-4d46-4e46-01d985838d76"

​
versionId
string | null

Version id of the record.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

​
owner
string | null

The owner/white-label partner used by the firm.

Possible values: Smokeball, PracticeEvolve, TriConvey.

Example:

"Smokeball"

​
name
string | null

The name of the firm.

Example:

"Brown LLC"

​
status
object

The status of the firm.

​
productId
string | null

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

Example:

"SMK001"

​
addOnIds
string[] | null

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)

Possible values: ADD01, ADD003, ADD004, ADD005, ADD006, ADD007, ADD008, ADD010

Example:
["ADD01", "ADD003"]
​
email
string | null

The email of the firm.

Only supported in AUS.

Example:

"john.smith@law.com"

​
abn
string | null

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.

Example:

"1234567890"

​
acn
string | null

For AU: Australian Company Number (ACN) of the firm.

For UK: Company Registration Number (CRN) of the firm.

Only supported in AU and UK.

Example:

"1234567890"

​
streetAddress
object

Street address of the firm.

​
mailingAddress
object

Mailing address of the firm.

​
dxAddress
object

DX address of the firm.

Only supported in AUS.

​
phone
object

Phone number of the firm.

​
fax
object

Fax number of the firm.

Logo of the firm.

Example:

"https://example-logo-url.com/image"

​
stylingDetails
object

Styling details of the firm.

​
licenceNumbers
object[] | null

Licence numbers of the firm.