list_projects
Retrieve and filter construction projects from Procore using criteria like status, name, creation date, and custom fields to manage project portfolios.
Instructions
List projects. [Core/Portfolio] GET /rest/v1.0/projects
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | Unique identifier for the company. | |
| page | No | Page | |
| per_page | No | Elements per page | |
| filters__by_status | No | Filters on project status. Must be one of Active, Inactive, or All. | |
| filters__name | No | Filters projects to those matching the given string. | |
| filters__created_at | 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-... | |
| filters__updated_at | 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 `YYY... | |
| filters__origin_id | No | Origin ID. Returns item(s) with the specified Origin ID. | |
| filters__from_project_template_id | No | Filter projects by the project template ID they were created from. Returns projects that were created from the specified project template. | |
| filters__id | No | Return item(s) with the specified IDs. | |
| filters__synced | No | If true, returns only item(s) with a `synced` status. | |
| filters__vendor_id | No | Return item(s) with the specified Vendor ID. | |
| filters__custom_fields | No | JSON object returns project with matching custom_field_values | |
| serializer_view | No | The 'compact' view only returns id, name and display_name. Passing any other value (or passing no value at all) will result in the more complete list of attributes shown below. | |
| sort | No | Return items with the specified sort. |