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

Create and manage your SMB users' companies.

Codat Companies API is one of 40 APIs that Codat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Companies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 12 operations across 6 paths, and defines 20 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.

12 operations 6 paths 20 schemas 2 DELETE4 GET1 PATCH3 POST2 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 Companies 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 12

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

Companies 12

Create and manage your SMB users' companies.

POST
/companies
Create company
create-company body → 200400401402403429500503
GET
/companies
List companies
list-companies 5 params → 200400401402403404429500
GET
/companies/{companyId}
Get company
get-company 1 param → 200401402403404429500503
DELETE
/companies/{companyId}
Delete a company
delete-company 1 param → 204401402403404429500503
PUT
/companies/{companyId}
Replace company
replace-company 1 param body → 200401402403404429500503
PATCH
/companies/{companyId}
Update company
update-company 1 param body → 200401402403404429500503
GET
/companies/{companyId}/accessToken
Get company access token
get-company-access-token 1 param → 200401402403404429500503
PUT
/companies/{companyId}/products/{productIdentifier}
Add product
add-product 2 params → 204401402403404429500503
DELETE
/companies/{companyId}/products/{productIdentifier}
Remove product
remove-product 2 params → 204401402403404429500503
POST
/companies/{companyId}/products/{productIdentifier}/refresh
Refresh product data
refresh-product-data 2 params body → 202400401402403404429500
GET
/companies/{companyId}/syncSettings
Get company sync settings
get-company-syncSettings 1 param → 200401402403404429500503
POST
/companies/{companyId}/syncSettings
Set company sync settings
set-company-syncSettings 1 param body → 204400401402403404429500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Connection (12 properties), Connection_2 (12 properties), Connection_3 (12 properties), Integration (11 properties). Each schema is shown below with its type and property counts.

Company
object
In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/bank-feeds-api/sche…
Connection
object
A connection represents a [company's](https://docs.codat.io/bank-feeds-api/schemas/Company) connection to a data source and allows you to synchronize data (pu…
12 properties 9 required
CompanyUpdateRequest
object
3 properties
CompanyAccessToken
object
Details of the access token provisioned for a company.
ErrorMessage
object
7 properties
CompanyRequestBody
object
3 properties 1 required
Companies
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:…
Company_2
object
In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/lending-api/schemas…
Connection_2
object
A connection represents a [company's](https://docs.codat.io/lending-api/schemas/Company) connection to a data source and allows you to synchronize data (pull…
12 properties 9 required
Companies_2
PagingInfo
object
4 properties 4 required
Company_3
object
In Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/platform-api/schema…
Connection_3
object
A connection represents a [company's](https://docs.codat.io/platform-api/schemas/Company) connection to a data source and allows you to synchronize data (pull…
12 properties 9 required
DataStatus
object
Describes the state of data in the Codat cache for a company and data type
5 properties 2 required
Integration
object
An integration that Codat supports
11 properties 4 required
Companies_3
Branding
object
3 properties
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
CompanySyncSettings
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

codat-companies-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 Company info API
Where this information came from

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