How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Smokeball Firm API

The Firm API from Smokeball — 3 operation(s) for firm.

Smokeball Firm API is one of 34 APIs that Smokeball publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Firm. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, a GitHub repository, and 1 JSON Schema.

This API exposes 7 operations across 3 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 6 base URLs: https://api.smokeball.com, https://api.smokeball.com.au, https://api.smokeball.co.uk, https://stagingapi.smokeball.com, https://stagingapi.smokeball.com.au, https://stagingapi.smokeball.co.uk.

7 operations 3 paths 20 schemas 1 DELETE3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.smokeball.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Smokeball Firm API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (api-key). An API key is passed in the header as Authorization (token). By default, every request must be authenticated.

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Firm 7
GET
/firm
Get firm
GetFirm → 200404
PUT
/firm
Update firm
UpdateFirm body → 202404
POST
/firm
Create firm
CreateFirm body → 202400403
GET
/firmusers
Get firm user mappings
→ 200404
GET
/firmusers/{id}
Get firm user mapping
GetFirmUserByIdAsync 1 param → 200404
PUT
/firmusers/{id}
Update firm user mapping
1 param body → 202400403404
DELETE
/firmusers/{id}
Delete firm user mapping
1 param → 200202404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Firm (23 properties), FirmAddress (17 properties), FirmAddressDto (17 properties), CreateFirmDto (14 properties). Each schema is shown below with its type and property counts.

FirmAccountStatus
string
FirmDxAddressDto
object
3 properties
LicenceNumber
object
3 properties
PhoneNumber
object
2 properties
StaffDto
object
14 properties
FirmSubscriptionDto
object
The subscription details for the firm.
3 properties
StylingDetails
object
3 properties
FirmStatusDto
object
The status of the firm.
2 properties
ProblemDetails
object
5 properties
FirmUser
object
8 properties
PhoneNumberDto
object
2 properties
DxAddress
object
3 properties
FirmAddress
object
17 properties
FirmAddressDto
object
17 properties
Link
object
4 properties
UpdateFirmDto
object
12 properties
FirmStatus
object
The status of the firm.
2 properties
FirmUserDto
object
Represents a mapping between a user and a staff member in a firm.
2 properties
Firm
object
23 properties
CreateFirmDto
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

smokeball-firm-api-openapi.yml Raw ↑

Other APIs Smokeball publishes across the network.

Smokeball Activity Codes API
Smokeball Authorization API
Smokeball Bank Accounts API
Smokeball Contacts API
Smokeball Events API
Smokeball Expenses API
Smokeball Fees API
Smokeball Files API
Smokeball Folders API
Smokeball Intake API
Smokeball Integrated Search API
Smokeball Invoices API
Where this information came from

This is an independent, third-party profile of Smokeball Firm API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.