Deel

Deel Custom Fields API

Custom fields on contracts and people

GitHub OpenAPI

Operations 1

GET /custom-fields/contracts List Contract Custom Fields #

Documentation

📖
Documentation
https://developer.deel.com/api/introduction
📖
GettingStarted
https://developer.deel.com/api/quickstart
📖
Authentication
https://developer.deel.com/api/authentication
📖
Documentation
https://developer.deel.com/api/employer-of-record/introduction
📖
Documentation
https://developer.deel.com/api/employer-of-record/employment-cost-calculator
📖
Documentation
https://developer.deel.com/api/employer-of-record/hiring
📖
Documentation
https://developer.deel.com/api/employer-of-record/accept-quote
📖
Documentation
https://developer.deel.com/api/contractors/introduction
📖
Documentation
https://developer.deel.com/api/contractors/invoice-adjustments
📖
Documentation
https://developer.deel.com/api/contractors/timesheets
📖
Documentation
https://developer.deel.com/api/global-payroll/introduction
📖
Documentation
https://developer.deel.com/api/global-payroll/time-tracking
📖
Documentation
https://developer.deel.com/api/global-payroll/adjustments
📖
Documentation
https://developer.deel.com/api/hris/introduction
📖
Documentation
https://developer.deel.com/api/scim-api/overview
📖
Documentation
https://developer.deel.com/api/hris-common-use-cases/sync-deel-users-to-identity-providers
📖
Documentation
https://developer.deel.com/api/ats-guides/introduction
📖
Documentation
https://developer.deel.com/api/ats-guides/getting-started
📖
Documentation
https://developer.deel.com/api/ats-guides/manage-jobs
📖
Documentation
https://developer.deel.com/api/ats-guides/manage-candidates-and-applications
📖
Documentation
https://developer.deel.com/api/ats-guides/webhooks
📖
Documentation
https://developer.deel.com/api/webhooks/introduction
📖
Documentation
https://developer.deel.com/api/webhooks/quickstart
📖
Documentation
https://developer.deel.com/api/webhooks/events
📖
Documentation
https://developer.deel.com/api/webhooks/simulations
📖
Documentation
https://developer.deel.com/api/platform/screenings
📖
Documentation
https://developer.deel.com/api/platform/immigration
📖
Documentation
https://developer.deel.com/api/deel-it/getting-started/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/openapi/deel-com-custom-fields-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-schema/deel-contract-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-schema/deel-person-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-schema/deel-eor-contract-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-schema/deel-payroll-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-schema/deel-time-off-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/deel-com/refs/heads/main/json-ld/deel-com-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/deel-com-custom-fields-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

deel-com-custom-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Deel Core Custom Fields API
  description: 'Core organizational, contract, and people APIs for Deel. Covers organizations,

    legal entities, departments, groups, managers, cost centers, contracts (IC, EOR,

    Global Payroll), invoice adjustments, lookups, magic links, tasks, and custom fields.


    Authentication uses bearer Organization or Personal API tokens generated from the

    Deel Developer Center. Production base URL is https://api.letsdeel.com/rest/v2 and

    the sandbox is https://api-sandbox.demo.deel.com/rest/v2.'
  version: '2026-05-25'
  contact:
    name: Deel Developer Support
    url: https://developer.deel.com/
  termsOfService: https://www.deel.com/legal/terms-of-service/
  license:
    name: Deel Developer Terms
    url: https://www.deel.com/legal/
servers:
- url: https://api.letsdeel.com/rest/v2
  description: Production
- url: https://api-sandbox.demo.deel.com/rest/v2
  description: Sandbox
security:
- BearerAuth: []
tags:
- name: Custom Fields
  description: Custom fields on contracts and people
paths:
  /custom-fields/contracts:
    get:
      operationId: getCustomFieldsContracts
      summary: List Contract Custom Fields
      tags:
      - Custom Fields
      responses:
        '200':
          description: Custom fields
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomField'
components:
  schemas:
    CustomField:
      type: object
      properties:
        id:
          type: string
        key:
          type: string
        label:
          type: string
        type:
          type: string
          enum:
          - text
          - number
          - date
          - select
          - boolean
        required:
          type: boolean
        options:
          type: array
          items:
            type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: Deel Organization or Personal API token issued from the Developer Center.