GET /rest/v1.0/projects/{project_id}/checklist/lists/grouped_index

Lists Grouped Checklist (Inspections) in a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Servers

https://api.procore.com

Path parameters

Name	Type	Required	Description
`project_id`	Integer	Yes	Unique identifier for the project.

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
`group_by`	String	No	Possible values: `"type"` `"template"` `"status"` `"trade"` `"created_by"` `"location"`
`filtersspec_section_id[]`	Array	No	Array of Specification Section IDs. Return item(s) associated to the specified Specification Section IDs.
`filtersdue_at`	String	No	Return item(s) due within the specified date range.
`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	Possible values: `"inspection_date"` `"name"` `"number"` `"location"` `"created_at"` `"updated_at"`
`filtersinspection_type_id[]`	Array	No	Array of Inspection Type IDs. Return item(s) associated with the specified Inspection Type IDs.
`filtersmanaged_equipment_id`	Integer	No	Return item(s) with the specified Managed Equipment ID.
`filterslist_template_id[]`	Array	No	Array of Checklist Template IDs. Return item(s) associated with the specified Checklist Template IDs.
`filterspoint_of_contact_id[]`	Array	No	Array of User IDs. Return item(s) where the specified User IDs are the point of contact.
`filtersresponsible_contractor_id[]`	Array	No	Array of Vendor IDs. Return item(s) where the specified Vendor IDs are the responsible contractor.
`filterslocation_id[]`	Array	No	Location ID. Returns item(s) with the specified Location ID or a range of Location IDs.
`filtersinspector_id[]`	Array	No	Array of User IDs. Return item(s) where the specified User IDs are inspectors.
`filtersclosed_by_id[]`	Array	No	Array of User IDs. Return item(s) closed by the specified User ID.
`page`	Integer	No	Page
`per_page`	Integer	No	Elements per page
`filtersstatus`	Integer	No	Return item(s) with the specified statuses
`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
`filtersinspection_date`	String	No	Return item(s) with inspection date within the specified ISO 8601 date range.
`filtersid[]`	Array	No	Return item(s) with the specified IDs.
`filterstrade_id`	Integer	No	Trade ID
`filtersclosed_at`	String	No	Returns item(s) closed within the specified ISO 8601 datetime range.
`filtersquery`	String	No	Return item(s) containing search query

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.