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

Returns a list of active users associated with a project.

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
`filterspermission_template`	Integer	No	Permission Template ID. Returns item(s) assiociated with the specified Permission Template ID.
`filterscreated_at`	String	No	Return item(s) created within the specified ISO 8601 datetime range. Formats: `YYYY-MM-DD`...`YYYY-MM-DD` - Date `YYYY-MM-DDTHH:MM:SSZ`...`YYYY-MM-DDTHH:MM:SSZ` - DateTime with UTC Offset `YYYY-MM-DDTHH:MM:SS+XX:00...`YYYY-MM-DDTHH:MM:SS+XX:00` - Datetime with Custom Offset
`sort`	String	No	Returns items with the specified sort. Possible values: `"name"` `"permission_template"` `"vendor_name"`
`filtersemployee`	Boolean	No	Returns users whose is_employee attribute matches the parameter.
`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 compact view. Otherwise, the default view is normal. Possible values: `"normal"` `"compact"`
`page`	Integer	No	Page
`filtersvendor_id[]`	Array	No	Return item(s) with the specified Vendor IDs.
`per_page`	Integer	No	Elements per page
`filtersupdated_at`	String	No	Return item(s) last updated within the specified ISO 8601 datetime range. Formats: `YYYY-MM-DD`...`YYYY-MM-DD` - Date `YYYY-MM-DDTHH:MM:SSZ`...`YYYY-MM-DDTHH:MM:SSZ` - DateTime with UTC Offset `YYYY-MM-DDTHH:MM:SS+XX:00`...`YYYY-MM-DDTHH:MM:SS+XX:00` - Datetime with Custom Offset
`filterssearch`	String	No	Returns users where the search string matches the user's first name, last name, email address, keywords, job title, or company name
`filtersorigin_id`	String	No	Origin ID. Returns item(s) with the specified Origin ID.
`filtersid`	Integer	No	Returns users whose id attribute matches the parameter.
`filterstrade_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.