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 Contacts API

The Contacts API from Smokeball — 6 operation(s) for contacts.

Smokeball Contacts 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 Contacts. 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 13 operations across 6 paths, and defines 47 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.

13 operations 6 paths 47 schemas 3 DELETE5 GET3 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 Contacts 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 13

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

Contacts 13
GET
/contacts/{contactId}/relations
Get contact relations
GetRelations 1 param → 200403404
POST
/contacts/{contactId}/relations
Create a contact relation
CreateRelation 1 param body → 202400403404
GET
/contacts/{contactId}/relations/{relatedContactId}
Get a contact relation
GetRelationById 2 params → 200403404
PUT
/contacts/{contactId}/relations/{relatedContactId}
Update a contact relation
UpdateRelation 2 params body → 202400403404
DELETE
/contacts/{contactId}/relations/{relatedContactId}
Delete a contact relation
DeleteRelation 2 params → 202403404
GET
/contacts
Get contacts
GetContacts 8 params → 200
POST
/contacts
Create a contact
CreateContact body → 202400403
GET
/contacts/{id}
Get a contact
GetContactById 1 param → 200403404
PUT
/contacts/{id}
Update a contact
UpdateContact 1 param body → 202400403404
DELETE
/contacts/{id}
Delete a contact
DeleteContact 1 param → 202403404
GET
/contacts/{id}/tags
Get contact tags
GetContactTagsById 1 param → 200403404
POST
/contacts/{id}/tags
Add tags to a contact
AddContactTags 1 param body → 201404
DELETE
/contacts/{id}/tags/{tagId}
Remove tags from a contact
RemoveContactTags 2 params body → 202400404

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are PersonDto (36 properties), Person (36 properties), Company (19 properties), CompanyDto (18 properties). Each schema is shown below with its type and property counts.

Tag
object
Represents a tag with an identifier, name, and type.
3 properties
Trustee
object
2 properties
TrusteeDto
object
2 properties
ContactDto
object
6 properties
TagCollection
object
6 properties
CitizenshipDetailsDto
object
3 properties
CitizenshipDetails
object
3 properties
DeathDetailsDto
object
8 properties
VoiDetails
object
Verification of Identity (VOI) details Only supported in AU.
5 properties
LinkPagedCollection
object
13 properties
Company
object
19 properties
PhoneNumber
object
2 properties
PhoneNumberWithExtensionDto
object
3 properties
Trust
object
9 properties
PoBoxAddressDto
object
PO Box address.
6 properties
PassportDetailsDto
object
5 properties
IdentificationDetailsDto
object
7 properties
ExecutionPerson
object
Represents an authorized person for organization execution Only supported in AU.
5 properties
AddressWithDxAddress
object
17 properties
ContactPagedCollection
object
13 properties
Address
object
16 properties
GroupOfPeople
object
4 properties
ContactRelationDto
object
2 properties
ExecutionOptions
object
Execution options for organizations Only supported in AU.
9 properties
ProblemDetails
object
5 properties
TrustDto
object
8 properties
DeathDetails
object
8 properties
PhoneNumberWithExtension
object
3 properties
ExecutionPersonDto
object
Represents an authorized person for organization execution Only supported in AU.
4 properties
PhoneNumberDto
object
2 properties
DxAddress
object
3 properties
ExecutionOptionsDto
object
Execution options for organizations (Company, Partnership, Sole Proprietor) Only supported in AU.
9 properties
PersonDto
object
36 properties
Link
object
4 properties
PoBoxAddress
object
6 properties
DxAddressDto
object
3 properties
UtbmsDetailsDto
object
Utbms Details
1 property
Contact
object
14 properties
PersonExecutionOptions
object
Execution options for individual persons (Power of Attorney) Only supported in AU.
8 properties
AddressWithDxAddressDto
object
17 properties
UtbmsDetails
object
Utbms Details
1 property
PersonExecutionOptionsDto
object
Execution options for individual persons (Power of Attorney) Only supported in AU.
7 properties
GroupOfPeopleDto
object
3 properties
CompanyDto
object
18 properties
Person
object
36 properties
PassportDetails
object
5 properties
AddressDto
object
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

smokeball-contacts-api-openapi.yml Raw ↑

Other APIs Smokeball publishes across the network.

Smokeball Activity Codes API
Smokeball Authorization API
Smokeball Bank Accounts API
Smokeball Events API
Smokeball Expenses API
Smokeball Fees API
Smokeball Files API
Smokeball Firm 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 Contacts 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.