GET /rest/v1.1/projects

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 for information on using the filtering capabilities provided by this endpoint.

Servers

https://api.procore.com

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
`filtersby_stage`		No	Return item(s) with the specified project stage ID(s).
`filtersby_department`		No	Return item(s) with the specified department ID(s).
`filterscustom_fields`	Object	No	JSON object returns project with matching custom_field_values
`filterssynced`	Boolean	No	If true, returns only item(s) with a `synced` status.
`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
`filtersby_status`	String	No	Filters on project status. Must be one of Active, Inactive, or All. Possible values: `"Inactive"` `"Active"` `"All"`
`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	Return items with the specified sort. Possible values: `"display_name"` `"name"`
`filtersby_region`		No	Return item(s) with the specified project region ID(s).
`company_id`	Integer	Yes	Unique identifier for the company.
`filtersproject_number`	String	No	Filters on project number.
`filtersby_type`		No	Return item(s) with the specified project type ID(s).
`filtersis_demo`	Boolean	No	Filters on project is_demo attribute, which indicates whether project is for demonstration purposes.
`view`	String	No	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' returns more fields, while 'extended' returns all the project information Possible values: `"extended"` `"normal"` `"compact"` `"ids"`
`page`	Integer	No	Page
`filtersname`	String	No	Filters projects to those matching the given string.
`filtersvendor_id`	Integer	No	Return item(s) with the specified Vendor ID.
`filtersby_owner_type`		No	Return item(s) with the specified project owner type ID(s).
`per_page`	Integer	No	Elements per page
`filtersby_bid_type`		No	Return item(s) with the specified project bid type ID(s).
`filtersorigin_id`	String	No	Origin ID. Returns item(s) with the specified Origin ID.
`filterstemplate`	Boolean	No	Filters on project template attribute, which indicates whether project is a template
`filtersid[]`	Array	No	Return item(s) with the specified IDs.
`filtersby_program`		No	Return item(s) with the specified project program ID(s).
`filtersby_office`		No	Return item(s) with the specified office 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.