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

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
sort String No

Returns items with the specified sort.

Possible values:

  • "name"
  • "permission_template"
  • "vendor_name"
filters[permission_template] Integer No

Permission Template ID. Returns item(s) assiociated with the specified Permission Template ID.

filters[created_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

filters[trade_id][][] Array No

Returns users whose vendor record is associated with the specified trade id(s).

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

filters[origin_id] String No

Origin ID. Returns item(s) with the specified Origin ID.

filters[id] Integer No

Returns users whose id attribute matches the parameter.

filters[employee] Boolean No

Returns users whose is_employee attribute matches the parameter.

per_page Integer No

Elements per page

filters[search] String No

Returns users where the search string matches the user's first name, last name, email address, keywords, job title, or company name

filters[updated_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

filters[vendor_id][] Array No

Return item(s) with the specified Vendor IDs.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.