---
title: "Get firm"
method: GET
path: "/firm"
tags: ["Firm"]
---

# Get firm

`GET /firm`

Retrieves the details of the firm associated with the authenticated client.

## Response `200`

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

- Firm
  - `href` string, nullable
  - `relation` string, nullable
  - `method` string, nullable
  - `self` Link
    - `id` string, nullable
    - `href` string, nullable
    - `relation` string, nullable
    - `method` string, nullable
  - `id` string, nullable — Unique identifier of the firm.
  - `versionId` string, nullable — Version id of the record.
  - `owner` string, nullable — The owner/white-label partner used by the firm. Possible values: Smokeball, PracticeEvolve, TriConvey.
  - `name` string, nullable — The name of the firm.
  - `status` FirmStatus — The status of the firm.
    - `status` 'Active' | 'Warning' | 'Suspended'
    - `statusMessage` string, nullable — The status message of the firm.
  - `productId` string, nullable — 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
  - `addOnIds` string[], nullable — 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
  - `email` string, nullable — The email of the firm. Only supported in AUS.
  - `abn` string, nullable — 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.
  - `acn` string, nullable — For AU: Australian Company Number (ACN) of the firm. For UK: Company Registration Number (CRN) of the firm. Only supported in AU and UK.
  - `streetAddress` FirmAddress
    - `buildingLevel` string, nullable — Building level in address (if applicable).
    - `unitNumber` string, nullable — Unit number in address (if applicable).
    - `unitType` string, nullable — Unit type (e.g. Unit,Flat,Villa,Suite,etc.) in address (if applicable).
    - `streetNumber` string, nullable — Street number in address.
    - `streetName` string, nullable — Street name in address.
    - `streetType` string, nullable — Street type (e.g. Street,Road,Avenue,Lane,etc.) in address.
    - `addressLine1` string, nullable — First line of address.
    - `addressLine2` string, nullable — Second line of address (if applicable).
    - `city` string, nullable — City, district, suburb, town, or village.
    - `state` string, nullable — State, province, or region.
    - `zipCode` string, nullable — Zip or post code.
    - `county` string, nullable — County (if applicable)
    - `locality` string, nullable — Locality (if applicable)
    - `country` string, nullable — Country.
    - `careOf` string, nullable — Care of the addressee (if applicable).
    - `poBoxType` string, nullable — PO box type in address (if applicable).
    - `poBoxNumber` string, nullable — PO box Number in address (if applicable).
  - `mailingAddress` FirmAddress
    - `buildingLevel` string, nullable — Building level in address (if applicable).
    - `unitNumber` string, nullable — Unit number in address (if applicable).
    - `unitType` string, nullable — Unit type (e.g. Unit,Flat,Villa,Suite,etc.) in address (if applicable).
    - `streetNumber` string, nullable — Street number in address.
    - `streetName` string, nullable — Street name in address.
    - `streetType` string, nullable — Street type (e.g. Street,Road,Avenue,Lane,etc.) in address.
    - `addressLine1` string, nullable — First line of address.
    - `addressLine2` string, nullable — Second line of address (if applicable).
    - `city` string, nullable — City, district, suburb, town, or village.
    - `state` string, nullable — State, province, or region.
    - `zipCode` string, nullable — Zip or post code.
    - `county` string, nullable — County (if applicable)
    - `locality` string, nullable — Locality (if applicable)
    - `country` string, nullable — Country.
    - `careOf` string, nullable — Care of the addressee (if applicable).
    - `poBoxType` string, nullable — PO box type in address (if applicable).
    - `poBoxNumber` string, nullable — PO box Number in address (if applicable).
  - `dxAddress` DxAddress
    - `number` string, nullable — Direct Exchange number (if applicable).
    - `exchange` string, nullable — Direct Exchange name.
    - `state` string, nullable — State, province, or region.
  - `phone` PhoneNumber
    - `areaCode` string, nullable — Phone area code.
    - `number` string, nullable — Phone number (excluding area code).
  - `fax` PhoneNumber
    - `areaCode` string, nullable — Phone area code.
    - `number` string, nullable — Phone number (excluding area code).
  - `logo` string, nullable — Logo of the firm.
  - `stylingDetails` StylingDetails
    - `primaryColorHexCode` string, nullable — Firm's primary color hex code.
    - `secondaryColorHexCode` string, nullable — Firm's secondary color hex code.
    - `fontFamilyName` string, nullable — Firm's font family name.
  - `licenceNumbers` LicenceNumber[], nullable — Licence numbers of the firm.
    - `state` string, nullable — State associated to the licence.
    - `type` string, nullable — Type of the licence.
    - `number` string, nullable — Licence number.
  - `createdDate` string, date-time, nullable — The date when the firm was created in UTC.

## Other responses

- `404` — When firm does not exist.

---

[API](https://skmtc.net/smokeball/apis/api.md) · [All operations](https://skmtc.net/smokeball/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smokeball/api/revisions/197984da9b42/schema)