Docs
Get Procurement
GET /procurements/{procurementId}
GET
/procurements/{procurementId}Required Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Returns full detail for a single procurement, including all resources with their order line allocations, schedule context, and any linked advance requests.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| procurementId | Guid | Required | The ID of the procurement. Replace `{{procurementId}}` in the URL. |
Response
| Field | Type | Description |
|---|---|---|
| id | Guid | Procurement ID. |
| name | string | Procurement name. |
| description | string | Description. |
| status | string | Current status. |
| resources | Resource[] | Resources with full detail. |
| resources[].id | Guid | Resource ID. |
| resources[].status | string | Resource status. |
| resources[].quantity | int | Total quantity available. |
| resources[].startDateTime | DateTimeOffset| null | Derived start (min of all schedule block starts). Null if no blocks. |
| resources[].endDateTime | DateTimeOffset| null | Derived end (max of all schedule block ends). Null if no blocks. |
| resources[].areaId | Guid| null | Area context link (only set when resource has no schedule blocks). |
| resources[].collaboratorId | Guid| null | Collaborator context link (only set when resource has no schedule blocks). |
| resources[].cloneGroupId | Guid| null | Shared ID for resources cloned from the same source. |
| resources[].type | object | Resource type (`{ id, label, icon, lineItemLabel }`). |
| resources[].subAssets | SubAsset[] | Sub-assets with properties. |
| resources[].properties | Property[] | Resource-level properties (`{ id, templatePropertyId, value }`). |
| resources[].orderLines | OrderLine[] | Order line items allocated against this resource. |
| resources[].orderLines[].id | Guid | Line item ID. |
| resources[].orderLines[].orderId | Guid | Parent order ID. |
| resources[].orderLines[].orderName | string | Parent order name. |
| resources[].orderLines[].quantity | int | Quantity allocated by this line item. |
| resources[].requests | Request[] | Advance requests linked directly to this resource (`{ id }`). |