Using Codat's API

The Codat public API provides secure access to contributed business data from your SME customers, all mapped to our unique standardized data model.

A single REST API with over 40 different groups of endpoints, the API supports a wide range of operations and HTTP methods, including:

  • Pulling data—GET methods
  • Pushing data—POST methods
  • Updating data—PUT methods

Requests and responses are in JSON only, and the API implements robust error handling.

Complex business data—like orders, payments and taxes—is represented in a wide range of data types using logical and consistent schemas.

The API is secured using an OAuth 2.0 authorization flow.

Over 30 different integrations provide pre-built, standardized connectivity between the Codat API and supported accounting, banking, eCommerce, PoS, and payment software (both cloud and on-premise).

If you want to build to our API directly, you can explore the API endpoints and schemas in our Swagger documentation.

Using Swagger

Once you have logged into Codat, you can use the "Login" button in Swagger to authenticate with your open instance of Codat.

  1. In a new tab, open our Swagger documentation.
  2. In the top right of Swagger, press the "Authorize" button.
  3. On the pop-up window, you can either enter your API Key then click the "Authorize" button; or click the "Login" button at the bottom where you will be prompted to login to your Codat account.
Codat's Swagger Login PageCodat's Swagger Login Page

Codat's Swagger Login Page

  1. You are now logged in and can make API queries against your Codat instance. For example, you might click on the /companies endpoint to retrieve a list of Companies in your Codat instance.

📘

"Try it Out"

Before you can make an API request in Swagger, you will need to click the "Try It Out" button in the top right of each endpoint to reveal the "Execute" button that sends your request.


Read next

When building to our API, you may wish to read more about:

Did this page help you?