REremote-com
Company Management

Show form schema

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

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Client credentials access tokenManage 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
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: company:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write

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

No recorded changes to this operation across all 1 revision of this API.