Generates PDF Document
generates_pdf_documentCreate a PDF document for a Procore project, listing users with optional filtering and grouping. Returns the URL to the generated PDF.
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. project_id defaults to the value set by procore_set_config when omitted. Acts on the generates PDF document and returns Procore's response for the operation. Failures come back as an error payload carrying the HTTP status — commonly 401 when the token has expired, 403 without tool permission, and 404 when an id does not resolve. Required parameters: project_id. Procore API: Core > Directory. Endpoint: POST /rest/v1.0/projects/{project_id}/users/pdf
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vendor | No | Query string parameter — indicates whether vendor should be included in PDF document. | |
| contact | No | Query string parameter — indicates whether contacts should be included in PDF document. | |
| user_role | No | Query string parameter — indicates whether user_role should be included in PDF document. | |
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| filters__id__ | No | Query string parameter — returns users whose id attribute matches the parameter. | |
| grouped_by_vendor | No | Query string parameter — indicates whether users should be grouped by vendor. | |
| filters__except_id | No | Query string parameter — returns users except as specified. | |
| filters__vendor_id | No | Query string parameter — return item(s) with the specified Vendor IDs. | |
| filters__trade_id__ | No | Query string parameter — returns users whose vendor record is associated with the specified trade id(s). | |
| filters__permission_template | No | Query string parameter — permission Template ID. Returns item(s) assiociated with the specified Permission Template ID. |