Companies
Company Management

Show form schema

Changed on

Returns the json schema of the requested company form. Currently only supports the address_details form.

Authentication

This endpoint requires the following token type:

  • Client credentials access token (OAuth2ClientCredentials) — obtained through the Client Credentials flow or the Refresh Token flow. See Authentication for partners.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)View companies (company:read)Manage companies (company:write)
get/v1/companies/schema

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/companies/schema
  • Auth: OAuth 2 (client credentials, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, company:read, company:write, company_admin, all:write, all:read)

Query parameters

country_codestring required

Country code according to ISO 3-digit alphabetic codes.

form'address_details' required

Name of the desired form

integer

Specific version number

OR
'latest'

Use latest version

Version of the form schema

Response

Success

dataobject

Example response

{
  "data": {
    "additionalProperties": false,
    "properties": {
      "address": {
        "maxLength": 255,
        "title": "Address",
        "type": "string"
      }
    }
  }
}

Changes

  • 09a7e24e0df5Revision changes
    • info

      the security scope company_admin was added to the endpoint's security scheme OAuth2ClientCredentials

    • info

      the security scope company_management was removed from the endpoint's security scheme OAuth2ClientCredentials

  • 9410f5f18a91Revision changes
    • info

      the security scope company_management was added to the endpoint's security scheme OAuth2ClientCredentials

    • info

      the security scope company_admin was removed from the endpoint's security scheme OAuth2ClientCredentials