List Project People
list_project_peopleGet a paginated list of people linked to a project, including directory and reference users. Filter by name, vendor, trade, or other criteria to locate specific records.
Instructions
Return a list of People associated with a Project. Includes users in the directory and reference users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. Use this to enumerate Directory records when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Directory records. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API: Core > Directory. Endpoint: GET /rest/v1.0/projects/{project_id}/people
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| view | No | Query string parameter — specifies which view of the resource to return (which attributes should be present in the response). Users without read permissions to Directory are limited to the normal and extended views. If a v... | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| filters__is_employee | No | Query string parameter — if true, returns item(s) where `is_employee` value is true. | |
| filters__reference_users_only | No | Query string parameter — if true, returns only people who are reference users. | |
| filters__without_reference_users | No | Query string parameter — if true, returns only people who are not reference users. | |
| filters__include_company_people | No | Query string parameter — if true, returns people in the Company not just the Project. This option only works if the user has permission to create people in the project directory or permission to read from the company direc... | |
| filters__search | No | Query string parameter — returns People where the search string matches the Person's name (first, last, or full), email address, mobile phone, business phone, fax number, or job title. | |
| filters__connected | No | Query string parameter — if true, returns only people who are connected users. If false, returns only people who are not connected users. | |
| filters__vendor_id | No | Query string parameter — return item(s) with the specified Vendor IDs. | |
| filters__job_title | No | Query string parameter — returns only people who have the specified job title. | |
| filters__country_code | No | Query string parameter — returns only people who have the specified country code. | |
| filters__state_code | No | Query string parameter — returns only people who have the specified state code. | |
| filters__trade_id | No | Query string parameter — array of Trade IDs. Returns item(s) with the specified Trade IDs. | |
| filters__permission_template_id | No | Query string parameter — array of Permission Template IDs. Returns item(s) with the specified Permission Template IDs. | |
| sort | No | Query string parameter — return items with the specified sort |