Get custom fields from contracts | Deel

curl https://api.letsdeel.com/rest/v2/contracts/custom_fields/d290f1ee-6c54-4b01-90e6-d701748f0851 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "Employee Bonus Eligibility",
    "type": {
      "name": "currency",
      "currency": "USD",
      "is_fixed": false
    },
    "settings": {
      "access": {
        "provided_by": "organization",
        "is_sensitive": true
      },
      "required": false,
      "countries": [
        "US",
        "GB",
        "CA"
      ],
      "is_enabled": true,
      "worker_types": [
        "contractor",
        "eor"
      ]
    },
    "placement": "contract",
    "created_at": "2023-11-01T09:15:30.000Z",
    "description": "Indicates if the employee is eligible for a performance bonus"
  }
}

curl https://api.letsdeel.com/rest/v2/contracts/custom_fields/d290f1ee-6c54-4b01-90e6-d701748f0851 \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "data": {
    "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "name": "Employee Bonus Eligibility",
    "type": {
      "name": "currency",
      "currency": "USD",
      "is_fixed": false
    },
    "settings": {
      "access": {
        "provided_by": "organization",
        "is_sensitive": true
      },
      "required": false,
      "countries": [
        "US",
        "GB",
        "CA"
      ],
      "is_enabled": true,
      "worker_types": [
        "contractor",
        "eor"
      ]
    },
    "placement": "contract",
    "created_at": "2023-11-01T09:15:30.000Z",
    "description": "Indicates if the employee is eligible for a performance bonus"
  }
}

Retrieves a single custom field definition from a contract by its id, returning the field’s name, type, settings, placement, and description. 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. ```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/

Path parameters

idstringRequiredformat: "uuid"

Custom field id.

Response

Successful response

dataobject

Custom field object

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl https://api.letsdeel.com/rest/v2/contracts/custom_fields/d290f1ee-6c54-4b01-90e6-d701748f0851 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"data": {
3	"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
4	"name": "Employee Bonus Eligibility",
5	"type": {
6	"name": "currency",
7	"currency": "USD",
8	"is_fixed": false
9	},
10	"settings": {
11	"access": {
12	"provided_by": "organization",
13	"is_sensitive": true
14	},
15	"required": false,
16	"countries": [
17	"US",
18	"GB",
19	"CA"
20	],
21	"is_enabled": true,
22	"worker_types": [
23	"contractor",
24	"eor"
25	]
26	},
27	"placement": "contract",
28	"created_at": "2023-11-01T09:15:30.000Z",
29	"description": "Indicates if the employee is eligible for a performance bonus"
30	}
31	}

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