List Checklists (Deprecated)
list_checklistsRetrieve checklists (inspections) for a Procore project, with filters for status, due date, location, and template. Discover checklist IDs before using other Procore tools.
Instructions
Lists Checklist (Inspections) in a specified Project grouped by a specified attribute. By default the Checklists are grouped by template. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint. DEPRECATED: Procore has deprecated this endpoint (as of 2022-01-24). It may be removed without further notice; prefer a newer version of this resource where one exists, and use procore_search_endpoints to find it. Use this to discover checklists or to look up the id of one before calling a tool that needs it. Returns a JSON array of checklists; page and per_page control pagination and the response reports how many pages remain. Read-only — it changes nothing in Procore. Failures come back as an error payload carrying the HTTP status — commonly 401 when the token has expired, 403 without tool permission, and 404 when an id does not resolve. Required parameters: project_id. Procore API: Project Management > Inspections. Endpoint: GET /rest/v1.0/checklist/lists
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for paginated results (default: 1, 1-indexed) | |
| per_page | No | Number of items per page (default: 100, max: 100) | |
| project_id | Yes | Query string parameter — unique identifier for the project. | |
| filters__view | No | Query string parameter — if 'recycle', return deleted Checklists. | |
| filters__due_at | No | Query string parameter — return item(s) due within the specified date range. | |
| filters__search | No | Query string parameter — returns item(s) matching the specified search query string. | |
| filters__status | No | Query string parameter — returns item(s) matching the specified status value. | |
| filters__trade_id | No | Query string parameter — filter results by trade id | |
| 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__location_id | No | Query string parameter — filters by specific location (Note: Use *either* this or location_id_with_sublocations, but not both) | |
| filters__inspector_id | No | Query string parameter — array of User IDs. Return item(s) where the specified User IDs are inspectors. | |
| filters__spec_section_id | No | Query string parameter — array of Specification Section IDs. Return item(s) associated to the specified Specification Section IDs. | |
| filters__list_template_id | No | Query string parameter — array of Checklist Template IDs. Return item(s) associated with the specified Checklist Template IDs. | |
| filters__inspection_type_id | No | Query string parameter — array of Inspection Type IDs. Return item(s) associated with the specified Inspection Type IDs. | |
| 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__responsible_contractor_id | No | Query string parameter — array of Vendor IDs. Return item(s) where the specified Vendor IDs are the responsible contractor. |