Deel

Deel Milestones API

Milestone-based contract deliverables

Documentation GitHub OpenAPI

Documentation

https://developer.deel.com/api/introduction

https://developer.deel.com/api/quickstart

https://developer.deel.com/api/authentication

https://developer.deel.com/api/employer-of-record/introduction

https://developer.deel.com/api/employer-of-record/employment-cost-calculator

https://developer.deel.com/api/employer-of-record/hiring

https://developer.deel.com/api/employer-of-record/accept-quote

https://developer.deel.com/api/contractors/introduction

https://developer.deel.com/api/contractors/invoice-adjustments

https://developer.deel.com/api/contractors/timesheets

https://developer.deel.com/api/global-payroll/introduction

https://developer.deel.com/api/global-payroll/time-tracking

https://developer.deel.com/api/global-payroll/adjustments

https://developer.deel.com/api/hris/introduction

https://developer.deel.com/api/scim-api/overview

https://developer.deel.com/api/hris-common-use-cases/sync-deel-users-to-identity-providers

https://developer.deel.com/api/ats-guides/introduction

https://developer.deel.com/api/ats-guides/getting-started

https://developer.deel.com/api/ats-guides/manage-jobs

https://developer.deel.com/api/ats-guides/manage-candidates-and-applications

https://developer.deel.com/api/ats-guides/webhooks

https://developer.deel.com/api/webhooks/introduction

https://developer.deel.com/api/webhooks/quickstart

https://developer.deel.com/api/webhooks/events

https://developer.deel.com/api/webhooks/simulations

https://developer.deel.com/api/platform/screenings

https://developer.deel.com/api/platform/immigration

https://developer.deel.com/api/deel-it/getting-started/introduction

Specifications

https://raw.githubusercontent.com/api-evangelist/deel/refs/heads/main/openapi/deel-com-milestones-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/deel/refs/heads/main/json-schema/deel-contract-schema.json

https://raw.githubusercontent.com/api-evangelist/deel/refs/heads/main/json-schema/deel-person-schema.json

https://raw.githubusercontent.com/api-evangelist/deel/refs/heads/main/json-schema/deel-eor-contract-schema.json

https://raw.githubusercontent.com/api-evangelist/deel/refs/heads/main/json-schema/deel-payroll-event-schema.json

https://raw.githubusercontent.com/api-evangelist/deel/refs/heads/main/json-schema/deel-time-off-schema.json

Other Resources

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

https://raw.githubusercontent.com/api-evangelist/deel/refs/heads/main/graphql/deel-com-graphql.md

OpenAPI Specification

openapi: 3.1.0
info:
  title: Deel ATS Adjustments Milestones API
  description: 'Applicant Tracking System API for managing the full recruiting pipeline — jobs and

    job postings, candidates, applications, attachments, offers, departments, locations,

    email templates, hiring members, employment types, application sources, tags, and

    reasons — with an end-to-end candidate-to-contract flow via Deel Hire.

    '
  version: '2026-05-25'
  contact:
    name: Deel Developer Support
    url: https://developer.deel.com/api/ats-guides/introduction
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: Milestones
  description: Milestone-based contract deliverables
paths:
  /contracts/{contract_id}/milestones:
    get:
      operationId: getMilestones
      summary: List Milestones
      tags:
      - Milestones
      parameters:
      - name: contract_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Milestones
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Milestone'
    post:
      operationId: createMilestone
      summary: Create Milestone
      tags:
      - Milestones
      parameters:
      - name: contract_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MilestoneCreate'
      responses:
        '201':
          description: Milestone created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Milestone'
components:
  schemas:
    Milestone:
      type: object
      properties:
        id:
          type: string
        contract_id:
          type: string
        title:
          type: string
        description:
          type: string
        amount:
          type: number
        currency:
          type: string
        status:
          type: string
          enum:
          - pending
          - in_progress
          - submitted
          - approved
          - paid
        due_date:
          type: string
          format: date
    MilestoneCreate:
      type: object
      required:
      - title
      - amount
      - currency
      properties:
        title:
          type: string
        description:
          type: string
        amount:
          type: number
        currency:
          type: string
        due_date:
          type: string
          format: date
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque