Skip to content

Deel: Retrieve a single milestone

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

← Milestones operations · Get started

Operation deel.milestones_getcontractmilestonebyid

Provider route: GET /contracts/{contract_id}/milestones/{milestone_id}. 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"]["getContractMilestoneById"]>[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.getContractMilestoneById(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_milestone_by_id(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
path.milestone_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 a single milestone — 200 response body

Referenced models: Retrieve a single milestone — 200 response body

Retrieve a single milestone — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve a single milestone — 200 response body — data

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

Retrieve a single milestone — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
amountstringRequired within parentAmount to be paid for the milestone.
approval_requestedbooleanRequired within parentIndicates if the contractor has requested the approval for the milestone.
created_atJSONRequired within parent
created_at (anyOf 1)stringAlternativeLong date-time format following ISO-8601
Pattern: ^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:?\d{2})?)?$
created_at (anyOf 2)nullAlternativeLong date-time format following ISO-8601
Pattern: ^\d{4}-\d{2}-\d{2}([T ]\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:?\d{2})?)?$
descriptionstringRequired within parentDescription of milestone.
idModelRequired within parentExpand Retrieve a single milestone — 200 response body — data id
reported_byModelRequired within parentExpand Retrieve a single milestone — 200 response body — data reported by
Milestone creator.
reviewed_byJSONRequired within parentReviewer's information.
reviewed_by (anyOf 1)ModelAlternativeExpand Retrieve a single milestone — 200 response body — data reviewed by Reviewer's information
reviewed_by (anyOf 2)nullAlternative
statusstringRequired within parentCurrent status of milestone.
titlestringRequired within parentTitle of milestone.

Referenced models: Retrieve a single milestone — 200 response body — data id, Retrieve a single milestone — 200 response body — data reported by, Retrieve a single milestone — 200 response body — data reviewed by Reviewer's information

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 a single milestone — 200 response body — data reported by
FieldTypePresenceDescription and constraints
$objectRootMilestone creator.
full_namestringOptionalReporter's full name.
idModelRequired within parentExpand Retrieve a single milestone — 200 response body — data id

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

Retrieve a single milestone — 200 response body — data reviewed by Reviewer's information
FieldTypePresenceDescription and constraints
$objectRootReviewer's information.
full_namestringOptionalReviewer's full name.
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_getcontractmilestonebyid. Catalog operation: milestones_getcontractmilestonebyid. 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.