Generates PDF Document
generates_pdf_documentGenerate a PDF document listing project users, with filters for permission template, vendor, and trade, and options to include contacts, vendors, or user roles, and group by vendor.
Instructions
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. Use this to perform the generates pdf action on Directory records. Generates the export and returns a download URL or async job handle. Required parameters: project_id. Procore API: Core > Directory. Endpoint: POST /rest/v1.0/projects/{project_id}/users/pdf
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| filters__permission_template | No | Query string parameter — permission Template ID. Returns item(s) assiociated with the specified Permission Template ID. | |
| filters__vendor_id | No | Query string parameter — return item(s) with the specified Vendor IDs. | |
| filters__id | No | Query string parameter — returns users whose id attribute matches the parameter. | |
| filters__except_id | No | Query string parameter — returns users except as specified. | |
| filters__trade_id__ | No | Query string parameter — returns users whose vendor record is associated with the specified trade id(s). | |
| contact | No | Query string parameter — indicates whether contacts should be included in PDF document. | |
| vendor | No | Query string parameter — indicates whether vendor should be included in PDF document. | |
| user_role | No | Query string parameter — indicates whether user_role should be included in PDF document. | |
| grouped_by_vendor | No | Query string parameter — indicates whether users should be grouped by vendor. |