> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.deel.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.deel.com/_mcp/server.

# Retrieve Milestones by Contract

GET https://api.letsdeel.com/rest/contracts/{contract_id}/milestones

Retrieves all milestones associated with a specific contract, including each milestone's title, amount, status, relevant dates, and creator and reviewer information.

 **Token scopes**: `milestones:read`

Reference: https://developer.deel.com/api/embedded/ic-endpoints/milestones/get-contract-milestones

## Authentication

- `Authorization` header (bearer token, required) — ## 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)
- `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

## Servers

- `https://api.letsdeel.com/rest` (Production, default)
- `https://api-staging.letsdeel.com/rest` (Demo)

## Request

### Path parameters

- `contract_id` (string, required) — The unique identifier of the Deel contract for which milestones are being retrieved.

## Response

### 200

A list of milestones for the specified contract.

- `data` (list of ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItems, required) — An array of milestone objects associated with the contract.

## Errors

### 400 Bad Request Error

Bad Request - The contract_id parameter failed validation.

- `errors` (list of ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Validation errors describing why the contract milestones could not be retrieved.

### 401 Unauthorized Error

Operation failed.

- `request` (ApiErrorRequest, optional)
- `errors` (list of ApiError, optional)

### 403 Forbidden Error

Forbidden - The requesting token does not have access to this organization.

- `errors` (list of ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Errors describing why access to the contract milestones was denied.

### 404 Not Found Error

Not Found - The specified contract does not exist.

- `errors` (list of ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Errors describing why the contract could not be found.

### 500 Internal Server Error

Internal Server Error - The contract milestones could not be retrieved due to an unexpected upstream or internal failure.

- `errors` (list of ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaErrorsItems, required) — Generic upstream or internal errors emitted when the contract milestones cannot be retrieved.

## Types

### ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItems

- `id` (ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsId, required)
- `title` (string, required) — The title of the milestone.
- `amount` (string, required) — The amount to be paid for completing this milestone.
- `status` (string, required) — The current status of the milestone, such as 'Pending Approval', 'Approved', or 'Completed'.
- `created_at` (string, required, nullable) — The creation date of the milestone in ISO-8601 format.
- `description` (string, required) — A detailed description of the milestone.
- `reported_by` (ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedBy, required) — Information about the creator of the milestone.
- `reviewed_by` (ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy, required, nullable) — Information about the person who reviewed the milestone.
- `approval_requested` (boolean, required) — Indicates whether approval has been requested for the milestone.

### ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaErrorsItems

- `message` (string, required) — Human-readable error message describing the unexpected condition.
- `code` (string, optional) — Machine-readable error code identifying the failure category.

### ApiErrorRequest

- `method` (string, optional) — The HTTP method of the failed request
- `url` (string, optional) — The relative URL of the failed request
- `status` (double, optional) — The status code of the response
- `api_req_id` (string, optional) — The request ID of the failed request
- `docs` (string, optional) — A link to the official documentation for the requested endpoint resource
- `source` (string, optional) — The source handler which produced the returned error
- `code` (double, optional) — The code of the source handler which produced the returned error

### ApiError

- `message` (string, optional) — A description of the returned error
- `path` (string, optional) — The JSON path where input validation failed

### ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsId

### ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedBy

Information about the creator of the milestone.

- `id` (ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedById, required)
- `full_name` (string, optional) — The full name of the person who reported the milestone.

### ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy

Information about the person who reviewed the milestone.

- `id` (ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedById, required)
- `full_name` (string, optional) — The full name of the person who reviewed the milestone.

### ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedById

### ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedById

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "title": "Initial Design Phase",
      "amount": "5000.00",
      "status": "Pending Approval",
      "created_at": "2024-11-26T15:30:00Z",
      "description": "Design the initial prototype of the application.",
      "reported_by": {
        "id": "00000000-0000-0000-0000-000000000000",
        "full_name": "Jane Smith"
      },
      "reviewed_by": {
        "id": "00000000-0000-0000-0000-000000000000",
        "full_name": "John Doe"
      },
      "approval_requested": true
    }
  ]
}
```

**SDK Code**

```python Example response for milestones
import requests

url = "https://api.letsdeel.com/rest/contracts/abcdefg/milestones"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Example response for milestones
const url = 'https://api.letsdeel.com/rest/contracts/abcdefg/milestones';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Example response for milestones
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.letsdeel.com/rest/contracts/abcdefg/milestones"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Example response for milestones
require 'uri'
require 'net/http'

url = URI("https://api.letsdeel.com/rest/contracts/abcdefg/milestones")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Example response for milestones
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.letsdeel.com/rest/contracts/abcdefg/milestones")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Example response for milestones
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.letsdeel.com/rest/contracts/abcdefg/milestones', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Example response for milestones
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/contracts/abcdefg/milestones");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Example response for milestones
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/contracts/abcdefg/milestones")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```