v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Countries

Show engagement agreement details

Returns the engagement agreement details JSON Schema for a country. Only DEU country is supported for now.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage company resources (company_admin)	View forms (form:read)	-

get/v1/countries/{country_code}/engagement-agreement-details

Path parameters

country_codestring required

Country code according to ISO 3-digit alphabetic codes

Response

Success

Example response

{
  "data": {
    "schema": {
      "properties": {
        "has_business_presence": {
          "enum": [
            "yes",
            "no"
          ],
          "title": "Do you currently have any business presence in Germany?",
          "type": "string"
        },
        "has_cba": {
          "enum": [
            "yes",
            "no"
          ],
          "title": "Are your German employees covered by any collective bargaining agreement (CBA)?",
          "type": "string"
        },
        "has_similar_roles": {
          "enum": [
            "yes",
            "no"
          ],
          "title": "Do you currently have team members in similar roles to this hire?",
          "type": "string"
        }
      },
      "type": "object"
    },
    "version": 1
  }
}