List Projects
list_projectsRetrieve a paginated list of active projects for a company. Filter by status, name, ID, or custom fields. Returns projects accessible to the authenticated user.
Instructions
Return a list of active Projects. If the authenticated user has full company admin permissions the request will return all of the projects in the company. If the user does not have full company admin permissions, the request will only return the projects that the user has been added to. The default pagination is 100 projects per page. The max page size is 300 projects due to the size of the data in the response. See [Filtering on List Actions](https://developers.procore.com/documentation/fi... Use this to enumerate Portfolio records when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Portfolio records. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: company_id. Procore API (v1.1): Core > Portfolio. Endpoint: GET /rest/v1.1/projects
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | Query string parameter — unique identifier for the company. | |
| 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) | |
| filters__by_status | No | Query string parameter — filters on project status. Must be one of Active, Inactive, or All. | |
| filters__name | No | Query string parameter — filters projects to those matching the given string. | |
| filters__project_number | No | Query string parameter — filters on project number. | |
| 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__origin_id | No | Query string parameter — origin ID. Returns item(s) with the specified Origin ID. | |
| filters__id | No | Query string parameter — return item(s) with the specified IDs. | |
| filters__synced | No | Query string parameter — if true, returns only item(s) with a `synced` status. | |
| filters__vendor_id | No | Query string parameter — return item(s) with the specified Vendor ID. | |
| filters__is_demo | No | Query string parameter — filters on project is_demo attribute, which indicates whether project is for demonstration purposes. | |
| filters__custom_fields | No | Query string parameter — jSON object returns project with matching custom_field_values | |
| filters__template | No | Query string parameter — filters on project template attribute, which indicates whether project is a template | |
| filters__by_owner_type | No | Query string parameter — return item(s) with the specified project owner type ID(s). | |
| filters__by_department | No | Query string parameter — return item(s) with the specified department ID(s). | |
| filters__by_region | No | Query string parameter — return item(s) with the specified project region ID(s). | |
| filters__by_office | No | Query string parameter — return item(s) with the specified office ID(s). | |
| filters__by_program | No | Query string parameter — return item(s) with the specified project program ID(s). | |
| filters__by_stage | No | Query string parameter — return item(s) with the specified project stage ID(s). | |
| filters__by_type | No | Query string parameter — return item(s) with the specified project type ID(s). | |
| filters__by_bid_type | No | Query string parameter — return item(s) with the specified project bid type ID(s). | |
| view | No | Query string parameter — the view determines which fields are returned. 'ids' return only id as an Integer (it additionally influences 'per_page' value to be strictly 200000), 'compact' returns only id and name, 'normal' r... | |
| sort | No | Query string parameter — return items with the specified sort. |