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

Codat Settings API

Manage company profile configuration, sync settings, and API keys.

Codat Settings API is one of 40 APIs that Codat 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, API documentation, and an API reference.

This API exposes 11 operations across 6 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 3.0.0.

Requests are made against a single base URL, https://api.codat.io.

11 operations 6 paths 11 schemas 1 DELETE5 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.0.0
Server
https://api.codat.io
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Codat Settings API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (auth_header). By default, every request must be authenticated.

  • auth_header — The word "Basic" followed by a space and your API key. [API keys](https://docs.codat.io/platform-api/schemas/ApiKeyDetails) are tokens used to control access t…

Paths & Operations 11

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

Settings 11

Manage company profile configuration, sync settings, and API keys.

GET
/connectionManagement/corsSettingsdeprecated
Get CORS settings (old)
get-connection-management-cors-settings → 200401402403404429500503
POST
/connectionManagement/corsSettingsdeprecated
Set CORS settings (old)
set-connection-management-cors-settings body → 200401402403404429500503
GET
/corsSettings
Get CORS settings
get-cors-settings → 200401402403404429500503
POST
/corsSettings
Set CORS settings
set-cors-settings body → 200401402403404429500503
GET
/profile
Get profile
get-profile → 200401402403429500503
PUT
/profile
Update profile
update-profile body → 200401402403429500503
GET
/profile/syncSettings
Get sync settings
get-profile-syncSettings → 200401402403429500503
POST
/profile/syncSettings
Update all sync settings
update-profile-syncSettings body → 204401402403429500503
GET
/apiKeys
List API keys
list-api-keys → 200401402403429500503
POST
/apiKeys
Create API key
create-api-key body → 201400401402403409429500
DELETE
/apiKeys/{apiKeyId}
Delete API key
delete-api-key 1 param → 204401402403404429500503

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are SyncSetting (8 properties), ErrorMessage (7 properties), Profile (7 properties), DataStatus (5 properties). Each schema is shown below with its type and property counts.

ClientId
string
Unique identifier for your client in Codat.
DataStatus
object
Describes the state of data in the Codat cache for a company and data type
5 properties 2 required
ErrorMessage
object
7 properties
CreateApiKey
object
Details about the newly created API key.
1 property
SyncSetting
object
Describes how often, and how much history, should be fetched for the given data type when a pull operation is queued.
8 properties 4 required
DateTime
string
In Codat's data model, dates and times are represented using the ISO 8601 standard . Date and time fields are formatted as strings; for example: 2020-10-08T22:…
Profile
object
Describes your Codat client instance
7 properties 2 required
ApiKeyDetails
object
Details of the API key.
ConnectionManagementAllowedOrigins
object
1 property
ApiKeys
object
1 property
SyncSettings
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

codat-settings-api-openapi.yml Raw ↑

Other APIs Codat publishes across the network.

Codat Sync for Expenses API
Codat Bill Pay API
Codat Spend Insights API
Codat Sync for Commerce API
Codat Sync for Payroll API
Codat Account mapping API
Codat Accounting bank data API
Codat Accounts payable API
Codat Accounts receivable API
Codat Bank accounts API
Codat Bank statements API
Codat Companies API
Where this information came from

This is an independent, third-party profile of Codat Settings 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.