Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Campfire

Campfire Settings API

Operations related to system and accounting settings configuration.

Documentation Provider Profile APIs.io OpenAPI GitHub

Campfire Settings API is one of 12 APIs that Campfire publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Settings. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 26 operations across 13 paths, and defines 11 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.meetcampfire.com.

26 operations 13 paths 11 schemas 3 DELETE11 GET4 PATCH4 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.meetcampfire.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Campfire Settings API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (knoxApiToken).

  • knoxApiToken — Token-based authentication with required prefix "Token"

Paths & Operations 26

Across 13 paths, the API surfaces 26 operations — 3 DELETE, 11 GET, 4 PATCH, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Settings 26

Operations related to system and accounting settings configuration.

GET
/ca/api/file
List Files
ca_api_file_list 5 params → 200
GET
/ca/api/file/{id}
Get File
ca_api_file_retrieve 1 param → 200
PUT
/ca/api/file/{id}
Update File
ca_api_file_update 1 param body → 200
PATCH
/ca/api/file/{id}
Patch File
ca_api_file_partial_update 1 param body → 200
DELETE
/ca/api/file/{id}
Delete File
ca_api_file_destroy 1 param → 204
GET
/ca/api/file/{id}/temp-download-url
Get File Temporary Download URL
get_file_temp_download_url 1 param → 200
POST
/ca/api/file/upload
Upload File
ca_api_file_upload_create → 200
GET
/ca/api/user_currency
List Customer Currencies
ca_api_user_currency_list 5 params → 200
POST
/ca/api/user_currency
Create Customer Currencies
ca_api_user_currency_create body → 201
GET
/ca/api/user_currency/{id}
Retrieve Customer Currencies
ca_api_user_currency_retrieve 1 param → 200
PUT
/ca/api/user_currency/{id}
Update Customer Currencies
ca_api_user_currency_update 1 param body → 200
PATCH
/ca/api/user_currency/{id}
Partial Update Customer Currencies
ca_api_user_currency_partial_update 1 param body → 200
DELETE
/ca/api/user_currency/{id}
Delete Customer Currencies
ca_api_user_currency_destroy 1 param → 204
GET
/ca/api/user_currency/rate
Get Currency Exchange Rate
ca_api_user_currency_rate_retrieve → 200
GET
/ca/api/user_currency/with_rate
Get Currencies Exchange Rates for Currency
ca_api_user_currency_with_rate_retrieve → 200
GET
/coa/api/chart-account-settings
Retrieve Chart Account Settings
settings_retrieve_chart_account_settings → 200
PUT
/coa/api/chart-account-settings
Update Chart Account Settings
settings_update_chart_account_settings body → 200
PATCH
/coa/api/chart-account-settings
Partially Update Chart Account Settings
settings_partial_update_chart_account_settings body → 200
GET
/coa/api/entity
List Chart Entities
coa_api_entity_list 2 params → 200
POST
/coa/api/entity
Create Chart Entity
coa_api_entity_create body → 201
GET
/coa/api/entity/{id}
Retrieve Chart Entity
coa_api_entity_retrieve 1 param → 200
PUT
/coa/api/entity/{id}
Update Chart Entity
coa_api_entity_update 1 param body → 200
PATCH
/coa/api/entity/{id}
Partial Update Chart Entity
coa_api_entity_partial_update 1 param body → 200
DELETE
/coa/api/entity/{id}
Delete Chart Entity
coa_api_entity_destroy 1 param → 204
POST
/coa/api/entity/{id}/logo
Upload Chart Entity Logo
coa_api_entity_logo_create 1 param → 200
GET
/coa/api/entity/for-intercompany
List All Entities for Intercompany JE
coa_api_entity_for_intercompany_list → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are PatchedChartAccountSettings (62 properties), ChartAccountSettings (62 properties), ChartEntity (51 properties), PatchedChartEntity (51 properties). Each schema is shown below with its type and property counts.

PatchedChartEntity
object
51 properties
CustomerCurrency
object
8 properties 7 required
PatchedChartAccountSettings
object
62 properties
File
object
17 properties 14 required
ChartEntity
object
51 properties 21 required
PatchedFile
object
17 properties
PaginatedCustomerCurrencyList
object
4 properties 2 required
ChartEntityMinimal
object
Minimal entity serializer for intercompany operations. Only exposes id, name, and currency - the minimum needed for entity selection in intercompany journal en…
3 properties 3 required
PatchedCustomerCurrency
object
8 properties
ChartAccountSettings
object
62 properties 29 required
PaginatedFileList
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

campfire-settings-api-openapi.yml Raw ↑

Other APIs Campfire publishes across the network.

Campfire Accounts Payable API
AE Profile APIs.io
Campfire Accounts Receivable API
AE Profile APIs.io
Campfire Bank Reconciliation API
AE Profile APIs.io
Campfire Cash Management API
AE Profile APIs.io
Campfire coa API
AE Profile APIs.io
Campfire Company Objects API
AE Profile APIs.io
Campfire Core Accounting API
AE Profile APIs.io
Campfire Custom Fields API
AE Profile APIs.io
Campfire Financial Statements API
AE Profile APIs.io
Campfire Integrations API
AE Profile APIs.io
Campfire Revenue Recognition API
AE Profile APIs.io
#Settings
← Back to C APIs
API Details
ID
campfire:campfire-settings-api
Base URL
https://api.meetcampfire.com
Docs
https://docs.campfire.ai
Provider
Campfire
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network