Retrieve Milestones by Contract | Deel

Retrieve a list of milestones associated with a specific contract. Each milestone includes details such as its title, amount, status, and relevant dates, along with information about the creator and reviewer. Token scopes: milestones:read

Authentication

AuthorizationBearer

Authentication

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

AuthorizationBearer

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

Path parameters

contract_idstringRequired

The unique identifier of the Deel contract for which milestones are being retrieved.

Response

A list of milestones for the specified contract.

datalist of objects

An array of milestone objects associated with the contract.

1	import requests
2
3	url = "https://api.letsdeel.com/rest/v2/contracts/37nex2x/milestones"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"data": [
3	{
4	"id": "00000000-0000-0000-0000-000000000000",
5	"title": "Initial Design Phase",
6	"amount": "5000.00",
7	"status": "Pending Approval",
8	"created_at": "2024-11-26T15:30:00Z",
9	"description": "Design the initial prototype of the application.",
10	"reported_by": {
11	"id": "00000000-0000-0000-0000-000000000000",
12	"full_name": "Jane Smith"
13	},
14	"reviewed_by": {
15	"id": "00000000-0000-0000-0000-000000000000",
16	"full_name": "John Doe"
17	},
18	"approval_requested": true
19	}
20	]
21	}

Authentication

Authentication

Path parameters

Response

Errors

Authentication