@codat/platform
Advanced tools
<!-- Start Codat Library Description --> Manage the building blocks of Codat, including companies, connections, and more. <!-- End Codat Library Description -->
Manage the building blocks of Codat, including companies, connections, and more.
Platform API: Platform API
An API for the common components of all of Codat's products.
These end points cover creating and managing your companies, data connections, and integrations.
Read about the building blocks of Codat... | See our OpenAPI spec
| Endpoints | Description |
|---|---|
| Companies | Create and manage your SMB users' companies. |
| Connections | Create new and manage existing data connections for a company. |
| Connection management | Configure connection management UI and retrieve access tokens for authentication. |
| Webhooks | Create and manage webhooks that listen to Codat's events. |
| Integrations | Get a list of integrations supported by Codat and their logos. |
| Refresh data | Initiate data refreshes, view pull status and history. |
| Settings | Manage company profile configuration, sync settings, and API keys. |
| Push data | Initiate and monitor Create, Update, and Delete operations. |
| Supplemental data | Configure and pull additional data you can include in Codat's standard data types. |
| Custom data type | Configure and pull additional data types that are not included in Codat's standardized data model. |
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @codat/platform
pnpm add @codat/platform
bun add @codat/platform
yarn add @codat/platform zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
import { CodatPlatform } from "@codat/platform";
const codatPlatform = new CodatPlatform({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatPlatform.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
}
run();
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
companiesAddProduct - Add productcompaniesCreate - Create companycompaniesDelete - Delete a companycompaniesGet - Get companycompaniesList - List companiescompaniesRemoveProduct - Remove productcompaniesUpdate - Update companyconnectionManagementCorsSettingsGet - Get CORS settingsconnectionManagementCorsSettingsSet - Set CORS settingsconnectionManagementGetAccessToken - Get access tokenconnectionsCreate - Create connectionconnectionsDelete - Delete connectionconnectionsGet - Get connectionconnectionsList - List connectionsconnectionsUnlink - Unlink connectionconnectionsUpdateAuthorization - Update authorizationcustomDataTypeConfigure - Configure custom data typecustomDataTypeGetConfiguration - Get custom data configurationcustomDataTypeList - List custom data type recordscustomDataTypeRefresh - Refresh custom data typeintegrationsGet - Get integrationintegrationsGetBranding - Get brandingintegrationsList - List integrationspushDataGetModelOptions - Get push optionspushDataGetOperation - Get push operationpushDataListOperations - List push operationsrefreshDataAll - Refresh all datarefreshDataByDataType - Refresh data typerefreshDataGet - Get data statusrefreshDataGetPullOperation - Get pull operationrefreshDataListPullOperations - List pull operationssettingsCreateApiKey - Create API keysettingsDeleteApiKey - Delete API keysettingsGetProfile - Get profilesettingsGetSyncSettings - Get sync settingssettingsListApiKeys - List API keyssettingsUpdateProfile - Update profilesettingsUpdateSyncSettings - Update all sync settingssupplementalDataConfigure - ConfiguresupplementalDataGetConfiguration - Get configurationwebhooksCreateConsumer - Create webhook consumerwebhooksDeleteConsumer - Delete webhook consumerwebhooksListConsumers - List webhook consumerswebhooksCreatewebhooksGetwebhooksListSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { CodatPlatform } from "@codat/platform";
const codatPlatform = new CodatPlatform({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatPlatform.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { CodatPlatform } from "@codat/platform";
const codatPlatform = new CodatPlatform({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatPlatform.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
}
run();
All SDK methods return a response object or throw an error. By default, an API error will throw a errors.SDKError.
If a HTTP request fails, an operation my also throw an error from the sdk/models/errors/httpclienterrors.ts module:
| HTTP Client Error | Description |
|---|---|
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the list method may throw the following errors:
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.ErrorMessage | 400, 401, 402, 403, 404, 429, 500, 503 | application/json |
| errors.SDKError | 4XX, 5XX | */* |
import { CodatPlatform } from "@codat/platform";
import {
ErrorMessage,
SDKValidationError,
} from "@codat/platform/sdk/models/errors";
const codatPlatform = new CodatPlatform({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
let result;
try {
result = await codatPlatform.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
case (err instanceof SDKValidationError): {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case (err instanceof ErrorMessage): {
// Handle err.data$: ErrorMessageData
console.error(err);
return;
}
default: {
throw err;
}
}
}
}
run();
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
You can override the default server globally by passing a server index to the serverIdx optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | https://api.codat.io | None |
import { CodatPlatform } from "@codat/platform";
const codatPlatform = new CodatPlatform({
serverIdx: 0,
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatPlatform.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
}
run();
The default server can also be overridden globally by passing a URL to the serverURL optional parameter when initializing the SDK client instance. For example:
import { CodatPlatform } from "@codat/platform";
const codatPlatform = new CodatPlatform({
serverURL: "https://api.codat.io",
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatPlatform.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
}
run();
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
import { CodatPlatform } from "@codat/platform";
import { HTTPClient } from "@codat/platform/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new CodatPlatform({ httpClient });
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
authHeader | apiKey | API key |
To authenticate with the API the authHeader parameter must be set when initializing the SDK client instance. For example:
import { CodatPlatform } from "@codat/platform";
const codatPlatform = new CodatPlatform({
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});
async function run() {
const result = await codatPlatform.companies.list({
page: 1,
pageSize: 100,
query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
orderBy: "-modifiedDate",
});
// Handle the result
console.log(result);
}
run();
For supported JavaScript runtimes, please consult RUNTIMES.md.
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { CodatPlatform } from "@codat/platform";
const sdk = new CodatPlatform({ debugLogger: console });
If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. You can raise any issues by contacting your dedicated Codat representative or reaching out to our support team. We're here to help ensure a smooth experience for you.
FAQs
<!-- Start Codat Library Description --> Manage the building blocks of Codat, including companies, connections, and more. <!-- End Codat Library Description -->
The npm package @codat/platform receives a total of 826 weekly downloads. As such, @codat/platform popularity was classified as not popular.
We found that @codat/platform demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
A malicious Chrome extension posing as an Ethereum wallet steals seed phrases by encoding them into Sui transactions, enabling full wallet takeover.
Security News
Socket is heading to London! Stop by our booth or schedule a meeting to see what we've been working on.
Security News
OWASP’s 2025 Top 10 introduces Software Supply Chain Failures as a new category, reflecting rising concern over dependency and build system risks.