Properties
| Name | Type | Description |
|---|---|---|
| name | string | The name given to the instance. |
| logoUrl | string | Static url to your organization's logo. |
| iconUrl | string | Static url to your organization's icon. |
| redirectUrl | string | The redirect URL pasted on to the SMB once Codat's [Hosted Link](https://docs.codat.io/auth-flow/authorize-hosted-link) has been completed by the SMB. |
| whiteListUrls | array | A list of urls that are allowed to communicate with Codat. If empty any url is allowed to communicate with Codat. |
| apiKey | string | The API key for this Codat instance. |
| confirmCompanyName | boolean | `True` if the company name has been confirmed. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Profile",
"title": "Profile",
"description": "Describes your Codat client instance",
"examples": [
{
"name": "Bob's Burgers",
"logoUrl": "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png",
"iconUrl": "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico",
"redirectUrl": "https://bobs-burgers.{countrySuffix}/{companyId}",
"whiteListUrls": [
"https://bobs-burgers.com",
"https://bobs-burgers.co.uk"
],
"confirmCompanyName": true
}
],
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Bob's Burgers",
"description": "The name given to the instance."
},
"logoUrl": {
"type": "string",
"description": "Static url to your organization's logo.",
"example": "https://client-images.codat.io/logo/042399f5-d104-4f38-9ce8-cac3524f4e88_5806cb1f-7342-4c0e-a0a8-99bfbc47b0ff.png"
},
"iconUrl": {
"type": "string",
"description": "Static url to your organization's icon.",
"example": "https://client-images.codat.io/icon/042399f5-d104-4f38-9ce8-cac3524f4e88_3f5623af-d992-4c22-bc08-e58c520a8526.ico"
},
"redirectUrl": {
"type": "string",
"example": "https://bobs-burgers.{countrySuffix}/{companyId}",
"description": "The redirect URL pasted on to the SMB once Codat's [Hosted Link](https://docs.codat.io/auth-flow/authorize-hosted-link) has been completed by the SMB."
},
"whiteListUrls": {
"type": "array",
"description": "A list of urls that are allowed to communicate with Codat. If empty any url is allowed to communicate with Codat.",
"items": {
"type": "string",
"format": "uri",
"example": "https://bobs-burgers.com",
"description": "A url that is allowed to communicate with Codat."
}
},
"apiKey": {
"type": "string",
"deprecated": true,
"example": "sartANTjHAkLdbyDfaynoTQb7pkmj6hXHmnQKMrB",
"description": "The API key for this Codat instance."
},
"confirmCompanyName": {
"type": "boolean",
"deprecated": true,
"description": "`True` if the company name has been confirmed."
}
},
"required": [
"name",
"redirectUrl"
],
"x-stoplight": {
"id": "b1fyq05edangf"
}
}Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/codat-profile"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.