v1
latestOpenAPI 3.1.02026-07-242735131.1 MBCompany Management
Show form schema
Returns the json schema of the requested company form. Currently only supports the address_details form.
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (company_admin) | View companies (company:read) | Manage companies (company:write) |
get/v1/companies/schema
Query parameters
country_codestring required
Country code according to ISO 3-digit alphabetic codes.
form'address_details' required
Name of the desired form
Version of the form schema
Response
Success
Example response
{
"data": {
"additionalProperties": false,
"properties": {
"address": {
"maxLength": 255,
"title": "Address",
"type": "string"
}
}
}
}