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

200
application/json

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

The response is of type object.