GET /rest/v1.0/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.

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
`sort`	String	No	Return items with the specified sort. Possible values: `"display_name"` `"name"`
`filters[custom_fields]`	Object	No	JSON object returns project with matching custom_field_values
`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
`company_id`	Integer	Yes	Unique identifier for the company.
`filters[name]`	String	No	Filters projects to those matching the given string.
`page`	Integer	No	Page
`filters[origin_id]`	String	No	Origin ID. Returns item(s) with the specified Origin ID.
`filters[id][]`	Array	No	Return item(s) with the specified IDs.
`per_page`	Integer	No	Elements per page
`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]`	Integer	No	Return item(s) with the specified Vendor ID.
`serializer_view`	String	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. Possible values: `"compact"`
`filters[by_status]`	String	No	Filters on project status. Must be one of Active, Inactive, or All. Possible values: `"Inactive"` `"Active"` `"All"`
`filters[synced]`	Boolean	No	If true, returns only item(s) with a `synced` status.

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.