List Project Users
list_project_usersRead-onlyIdempotent
Retrieve active users for a project with pagination and filtering. Use this to get directory records, find IDs, or filter by parameters.
Instructions
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. 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}/users
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| 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) | |
| 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 compact view. Otherwise, the defa... | |
| filters__created_at | No | Query string parameter — 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-... | |
| filters__updated_at | No | Query string parameter — 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 `YYY... | |
| filters__permission_template | No | Query string parameter — permission Template ID. Returns item(s) assiociated with the specified Permission Template ID. | |
| filters__vendor_id | No | Query string parameter — return item(s) with the specified Vendor IDs. | |
| filters__origin_id | No | Query string parameter — origin ID. Returns item(s) with the specified Origin ID. | |
| filters__trade_id__ | No | Query string parameter — returns users whose vendor record is associated with the specified trade id(s). | |
| filters__search | No | Query string parameter — returns users where the search string matches the user's first name, last name, email address, keywords, job title, or company name | |
| filters__employee | No | Query string parameter — returns users whose is_employee attribute matches the parameter. | |
| filters__id | No | Query string parameter — returns users whose id attribute matches the parameter. | |
| sort | No | Query string parameter — returns items with the specified sort. |