POST /rest/v1.0/projects/{project_id}/users/pdf
Generate PDF Document from a project. The endpoint returns url to PDF file. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Servers
- https://api.procore.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
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 |
|---|---|---|---|
contact |
Boolean | No |
Indicates whether contacts should be included in PDF document. |
vendor |
Boolean | No |
Indicates whether vendor should be included in PDF document. |
filters[id] |
Integer | No |
Returns users whose id attribute matches the parameter. |
user_role |
Boolean | No |
Indicates whether user_role should be included in PDF document. |
filters[permission_template] |
Integer | No |
Permission Template ID. Returns item(s) assiociated with the specified Permission Template ID. |
filters[except_id] |
Integer | No |
Returns users except as specified. |
grouped_by_vendor |
Boolean | No |
Indicates whether users should be grouped by vendor. |
filters[vendor_id][] |
Array | No |
Return item(s) with the specified Vendor IDs. |
filters[trade_id][][] |
Array | No |
Returns users whose vendor record is associated with the specified trade id(s). |
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.