v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-045244247.9 KB

Settings

Get profile

Fetch your Codat profile.

get/profile

Response

namestring required

The name given to the instance.

logoUrlstring

Static url to your organization's logo.

iconUrlstring

Static url to your organization's icon.

redirectUrlstring required

The redirect URL pasted on to the SMB once Codat's Hosted Link has been completed by the SMB.

whiteListUrlsstring[]

A list of urls that are allowed to communicate with Codat. If empty any url is allowed to communicate with Codat.

apiKeystring

The API key for this Codat instance.

confirmCompanyNameboolean

True if the company name has been confirmed.

Example response

{
  "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
}