Skip to content

Deel: Retrieve Milestones by Contract

Deel milestones.getContractMilestones: arguments, response, policy and SDK examples.

← Milestones operations · Get started

Operation deel.milestones_getcontractmilestones

Provider route: GET /contracts/{contract_id}/milestones. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["milestones"]["getContractMilestones"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.milestones.getContractMilestones(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.milestones.get_contract_milestones(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve Milestones by Contract — 200 response body

Referenced models: Retrieve Milestones by Contract — 200 response body

Retrieve Milestones by Contract — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentAn array of milestone objects associated with the contract.
data[]ModelEach itemExpand Retrieve Milestones by Contract — 200 response body — data item

Referenced models: Retrieve Milestones by Contract — 200 response body — data item

Retrieve Milestones by Contract — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentThe amount to be paid for completing this milestone.
approval_requestedbooleanRequired within parentIndicates whether approval has been requested for the milestone.
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeThe creation date of the milestone in ISO-8601 format.
Pattern: ^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:?\d{2})?)?$
created_at (anyOf 2)nullAlternativeThe creation date of the milestone in ISO-8601 format.
Pattern: ^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:?\d{2})?)?$
descriptionstringRequired within parentA detailed description of the milestone.
idModelRequired within parentExpand Retrieve a single milestone — 200 response body — data id
reported_byModelRequired within parentExpand Retrieve Milestones by Contract — 200 response body — data item reported by
Information about the creator of the milestone.
reviewed_byJSONRequired within parentInformation about the person who reviewed the milestone.
reviewed_by (anyOf 1)ModelAlternativeExpand Retrieve Milestones by Contract — 200 response body — data item reviewed by full name, id
reviewed_by (anyOf 2)nullAlternative
statusstringRequired within parentThe current status of the milestone, such as 'Pending Approval', 'Approved', or 'Completed'.
titlestringRequired within parentThe title of the milestone.

Referenced models: Retrieve a single milestone — 200 response body — data id, Retrieve Milestones by Contract — 200 response body — data item reported by, Retrieve Milestones by Contract — 200 response body — data item reviewed by full name, id

Retrieve a single milestone — 200 response body — data id
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)integerAlternativeFormat: int64
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve Milestones by Contract — 200 response body — data item reported by
FieldTypePresenceDescription and constraints
$objectRootInformation about the creator of the milestone.
full_namestringOptionalThe full name of the person who reported the milestone.
idModelRequired within parentExpand Retrieve a single milestone — 200 response body — data id

Referenced models: Retrieve a single milestone — 200 response body — data id

Retrieve Milestones by Contract — 200 response body — data item reviewed by full name, id
FieldTypePresenceDescription and constraints
$objectRootInformation about the person who reviewed the milestone.
full_namestringOptionalThe full name of the person who reviewed the milestone.
idModelRequired within parentExpand Retrieve a single milestone — 200 response body — data id

Referenced models: Retrieve a single milestone — 200 response body — data id

SDK function policy ID: deel.milestones_getcontractmilestones. Catalog operation: milestones_getcontractmilestones. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["milestones:read"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.