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 Custom data type API

Configure and pull additional data types that are not included in Codat's standardized data model.

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

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

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

4 operations 3 paths 6 schemas 2 GET1 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 Custom data type 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 4

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

Custom data type 4

Configure and pull additional data types that are not included in Codat's standardized data model.

PUT
/integrations/{platformKey}/dataTypes/custom/{customDataIdentifier}
Configure custom data type
configure-custom-data-type 2 params body → 200401402403404429500503
GET
/integrations/{platformKey}/dataTypes/custom/{customDataIdentifier}
Get custom data configuration
get-custom-data-type-configuration 2 params → 200401402403404429500503
POST
/companies/{companyId}/connections/{connectionId}/data/queue/custom/{customDataIdentifier}
Refresh custom data type
refresh-custom-data-type 3 params → 200401402403404429451500
GET
/companies/{companyId}/connections/{connectionId}/data/custom/{customDataIdentifier}
List custom data type records
list-custom-data-type-records 5 params → 200400401402403404429451

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PullOperation (12 properties), ErrorMessage (7 properties), PagingInfo (4 properties), CustomDataTypeConfiguration (4 properties). Each schema is shown below with its type and property counts.

CustomDataTypeRecords
object
Resulting records pulled from the source platform for a specific custom data type.
4 properties
CustomDataTypeConfiguration
object
Client's configuration details for a specific custom data type and platform pair.
4 properties
ErrorMessage
object
7 properties
PagingInfo
object
4 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:…
PullOperation
object
Information about a queued, in progress or completed pull operation. Formally called dataset
12 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

codat-custom-data-type-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 Custom data type 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.