Deals
Get a deal
Retrieves a single deal by ID. Use the `include` parameter to embed related resources such as the linked contact, company, pipeline, or current stage.
Authorization
apiKey AuthorizationBearer <token>
API key from your nodestash dashboard. Pass as a Bearer token in the Authorization header.
In: header
Path Parameters
id*string
Deal ID (prefixed with dl_).
Match
^dl_Query Parameters
include?string
Comma-separated list of related resources to include. Supported values: contact, company, pipeline, stage. When included, the deal attributes will contain the corresponding embedded object (or null).
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://api.nodestash.io/v1/deals/dl_3xK8nM2qTsYvAzCeB2cD4?include=contact%2Ccompany"{
"data": {
"id": "dl_3xK8nM2qTsYvAzCeB2cD4",
"type": "deal",
"attributes": {
"id": "dl_3xK8nM2qTsYvAzCeB2cD4",
"title": "Enterprise Contract",
"value": "50000.00",
"currency": "EUR",
"pipeline_id": "pp_8rT4mK9pQsVwXyZaB2cD4",
"stage_id": "ps_4kT9mN2qRsYvAzCeB2cD4",
"contact_id": "ct_5hJ3kM9pQrVwXyZaB2cD4",
"company_id": "co_7rT4mK9pQsVwXyZaB2cD4",
"owner_id": null,
"expected_close_date": "2026-06-30",
"closed_at": null,
"custom_fields": {
"priority": "high"
},
"tags": [
"enterprise",
"q2-target"
],
"created_at": "2026-02-01T14:00:00Z",
"updated_at": "2026-02-01T14:00:00Z"
}
},
"meta": {
"request_id": "req_abc123def456"
}
}{
"error": {
"code": "INVALID_API_KEY",
"message": "Missing or invalid Authorization header"
},
"meta": {
"request_id": "req_abc123def456"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Contact not found"
},
"meta": {
"request_id": "req_abc123def456"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded"
},
"meta": {
"request_id": "req_abc123def456"
}
}