GET /rest/v1.0/companies/{company_id}/planroom/bid_packages/{bid_package_id}/documents
Returns list of all documents attached to Bid Package, with meta information about all drawings and PDM (Project Document Management) attachments. Supports optional pagination and sorting for PDM attachments via query parameters.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
company_id |
Integer | Yes |
Unique identifier for the company. |
bid_package_id |
Integer | Yes |
Bid Package ID |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
pdm_sort_order |
String | No |
Sort order for PDM attachments Valid values:
Default value: "asc" |
pdm_sort_by |
String | No |
Field to sort PDM attachments by Valid values:
Default value: "document_revision_id" |
pdm_search |
String | No |
Search term to filter PDM attachments by document_revision_id |
pdm_per_page |
Integer | No |
Number of PDM attachments per page |
pdm_page |
Integer | No |
Page number for paginating PDM attachments |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.