The Codat API client.

A %Codat.Client{} holds configuration for authenticating and communicating with the Codat API. Pass a client to any API function to use custom settings, or omit it to use the global application config.

Creating a Client

# From application config (reads :codat app config + CODAT_API_KEY env var)
client = Codat.Client.new()

# Explicit API key
client = Codat.Client.new(api_key: "your-api-key")

# Full custom configuration
client = Codat.Client.new(
  api_key: "your-api-key",
  base_url: "https://api.codat.io",
  http_timeout: 60_000,
  max_retries: 5
)

Using a Client

# All API functions accept an optional client as the first argument
{:ok, companies} = Codat.Platform.Companies.list(client)

# Without a client, uses global application config
{:ok, companies} = Codat.Platform.Companies.list()

Multi-Tenant Usage

Create one client per tenant to isolate API keys and configurations:

clients = Map.new(tenants, fn {id, key} ->
  {id, Codat.Client.new(api_key: key)}
end)

{:ok, companies} = Codat.Platform.Companies.list(clients[tenant_id])