List all custom fields

curl https://api.letsdeel.com/rest/v2/contracts/custom_fields \
     -H "Authorization: Bearer <token>"

{
  "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

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/

Authentication

Authentication

Response

Errors

Authentication