List Grouped Checklists (Inspections)
list_grouped_checklists_inspectionsRead-onlyIdempotent
Retrieve a paginated, grouped list of inspections in a project. Supports filtering by date, inspector, status, and more, with results organized by location, template, or trade.
Instructions
Lists Grouped Checklist (Inspections) in a specified Project. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. Use this to enumerate Inspections when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Inspections. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API: Project Management > Inspections. Endpoint: GET /rest/v1.0/projects/{project_id}/checklist/lists/grouped_index
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| 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__id | No | Query string parameter — return item(s) with the specified IDs. | |
| filters__inspection_date | No | Query string parameter — return item(s) with inspection date within the specified ISO 8601 date range. | |
| filters__inspection_type_id | No | Query string parameter — array of Inspection Type IDs. Return item(s) associated with the specified Inspection Type IDs. | |
| filters__inspector_id | No | Query string parameter — array of User IDs. Return item(s) where the specified User IDs are inspectors. | |
| filters__list_template_id | No | Query string parameter — array of Checklist Template IDs. Return item(s) associated with the specified Checklist Template IDs. | |
| filters__location_id | No | Query string parameter — location ID. Returns item(s) with the specified Location ID or a range of Location IDs. | |
| filters__managed_equipment_id | No | Query string parameter — return item(s) with the specified Managed Equipment ID. | |
| filters__point_of_contact_id | No | Query string parameter — array of User IDs. Return item(s) where the specified User IDs are the point of contact. | |
| filters__spec_section_id | No | Query string parameter — array of Specification Section IDs. Return item(s) associated to the specified Specification Section IDs. | |
| filters__responsible_contractor_id | No | Query string parameter — array of Vendor IDs. Return item(s) where the specified Vendor IDs are the responsible contractor. | |
| filters__closed_by_id | No | Query string parameter — array of User IDs. Return item(s) closed by the specified User ID. | |
| filters__created_by_id | No | Query string parameter — return item(s) created by the specified User IDs | |
| filters__status | No | Query string parameter — return item(s) with the specified statuses | |
| filters__trade_id | No | Query string parameter — filter results by trade id | |
| filters__query | No | Query string parameter — return item(s) containing search query | |
| filters__due_at | No | Query string parameter — return item(s) due within the specified date range. | |
| 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__closed_at | No | Query string parameter — returns item(s) closed within the specified ISO 8601 datetime range. | |
| sort | No | Query string parameter — sort order for results. Prefix with '-' for descending order | |
| group_by | No | Query string parameter — the group by for this Inspections operation |