Retrieve additional information fields for GP workers by country | Deel

import requests
url = "https://api.letsdeel.com/rest/v2/forms/gp/worker-additional-fields/ES"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "data": [
    {
      "key": "additional_name",
      "type": "string",
      "ui_guide": {
        "label": "Preferred Name / Additional Name",
        "order": 3,
        "field_type": "text",
        "local_label": "Imię preferowane",
        "description": "Preferred name / Additoinal name"
      },
      "validation": [
        {
          "regex": "^.*$",
          "error_message": "Review the value entered"
        }
      ],
      "is_required": false
    },
    {
      "key": "dob",
      "type": "string",
      "ui_guide": {
        "label": "Date of Birth",
        "order": 4,
        "field_type": "date",
        "local_label": "Data urodzenia",
        "description": "Date of Birth"
      },
      "validation": [
        {
          "regex": "^.*$",
          "error_message": "Review the value entered"
        }
      ],
      "is_required": true
    }
  ]
}

Retrieves GP workers additional information fields that are required for running payroll depending on the country regulations Token scopes: forms:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

country_codestringRequired

Country code

Response

Successful operation.

datalist of objects or null

Array of field configuration objects

1	{
2	"data": [
3	{
4	"key": "additional_name",
5	"type": "string",
6	"ui_guide": {
7	"label": "Preferred Name / Additional Name",
8	"order": 3,
9	"field_type": "text",
10	"local_label": "Imię preferowane",
11	"description": "Preferred name / Additoinal name"
12	},
13	"validation": [
14	{
15	"regex": "^.*$",
16	"error_message": "Review the value entered"
17	}
18	],
19	"is_required": false
20	},
21	{
22	"key": "dob",
23	"type": "string",
24	"ui_guide": {
25	"label": "Date of Birth",
26	"order": 4,
27	"field_type": "date",
28	"local_label": "Data urodzenia",
29	"description": "Date of Birth"
30	},
31	"validation": [
32	{
33	"regex": "^.*$",
34	"error_message": "Review the value entered"
35	}
36	],
37	"is_required": true
38	}
39	]
40	}

Authentication

Authentication

Path parameters

Response

Errors

Authentication