List all people custom fields | Deel

{
  "data": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "name": "Custom Field Name",
      "type": {
        "name": "text"
      },
      "settings": {
        "access": {
          "is_sensitive": true,
          "provided_by": "organization",
          "group_permission_set": "custom_fields_set1"
        },
        "required": true,
        "is_enabled": true,
        "countries": [
          "CA",
          "GB",
          "US"
        ],
        "worker_types": [
          "eor",
          "contractor"
        ]
      },
      "placement": "profile",
      "created_at": "2022-01-01T00:00:00Z",
      "description": "Description of the custom field"
    }
  ]
}

Returns the list of custom field definitions configured for people within the organization. The response includes field metadata, not specific person field values. It provides definitions with people placement for supported types such as text, list, multiselect, number, percentage, currency, date, and hyperlink.

Token scopes: people: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.

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

Learn more about authentication

AuthorizationBearer

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

Response

Successful response

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error