GET /rest/v1.0/projects/{project_id}/people

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.

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
`filterswithout_reference_users`	Boolean	No	If true, returns only people who are not reference users.
`filterspermission_template_id[]`	Array	No	Array of Permission Template IDs. Returns item(s) with the specified Permission Template IDs.
`filtersis_employee`	Boolean	No	If true, returns item(s) where `is_employee` value is true.
`sort`	String	No	Return items with the specified sort Possible values: `"name"` `"job_title"` `"permission_template"` `"vendor_name"`
`filtersstate_code`	String	No	Returns only people who have the specified state code.
`filtersinclude_company_people`	Boolean	No	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 directory.
`view`	String	No	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 valid view is not provided, it will default to normal. Possible values: `"extended"` `"normal"` `"web"`
`page`	Integer	No	Page
`filtersconnected`	Boolean	No	If true, returns only people who are connected users. If false, returns only people who are not connected users.
`filtersvendor_id[]`	Array	No	Return item(s) with the specified Vendor IDs.
`filtersjob_title`	String	No	Returns only people who have the specified job title.
`filterscountry_code`	String	No	Returns only people who have the specified country code.
`filtersreference_users_only`	Boolean	No	If true, returns only people who are reference users.
`per_page`	Integer	No	Elements per page
`filterssearch`	String	No	Returns item(s) matching the specified search query string.
`filterstrade_id[]`	Array	No	Array of Trade IDs. Returns item(s) with the specified Trade IDs.

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.