List all custom fields | Deel

import requests
url = "https://api.letsdeel.com/rest/v2/contracts/custom_fields"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "data": [
    {
      "id": "7015d676-6e53-47a1-8b01-2f0b2c550790",
      "name": "Employment Status",
      "type": {
        "name": "text"
      },
      "settings": {
        "access": {
          "is_sensitive": false,
          "provided_by": "organization",
          "group_permission_set": "custom_fields_set1"
        },
        "required": true,
        "is_enabled": true,
        "countries": [
          "CO",
          "PH"
        ],
        "worker_types": [
          "direct_employee",
          "hris_direct_employee"
        ]
      },
      "created_at": "2025-10-14T13:47:22.851Z",
      "placement": "contract",
      "description": "Custom Field Description"
    }
  ]
}

Use this endpoint to retrieve all custom fields defined for contracts. Use it when building contract creation or edit flows that need to display field options and requirements. This operation is read-only and non-destructive. Token scopes: contracts:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

1 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2   -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

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

Response

Successful response

datalist of objects

1	curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
2	-H 'Authorization: Bearer YOUR-TOKEN-HERE'

Authentication

Authentication

Response

Errors

Authentication