List Generic Tool Items
list_generic_tool_itemsRetrieve a list of generic tool items within a project and generic tool. Use it to discover items or find IDs for subsequent operations.
Instructions
Returns a list of all Generic Tool Items in the specified Project and Generic Tool. For more information on Generic Tool and Correspondence Tool endpoints, see Working with the Correspondence Tool. Use this to discover generic tool items or to look up the id of one before calling a tool that needs it. project_id defaults to the value set by procore_set_config when omitted, and generic_tool_id must identify an existing parent record — resolve it with the matching list tool first. Returns a JSON array of generic tool items; 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: generic_tool_id, project_id. Procore API: Company Admin > Custom - Configurable Tools. Endpoint: GET /rest/v1.0/projects/{project_id}/generic_tools/{generic_tool_id}/generic_tool_items
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| sort | No | Query string parameter — field to sort by. If the field is passed with a - (EX: -updated_at) it is sorted in reverse order | |
| view | No | Query string parameter — if supplied customize the response format | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) | |
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| filters__id | No | Query string parameter — return item(s) with the specified IDs. | |
| filters__query | No | Query string parameter — return item(s) containing search query | |
| filters__status | No | Query string parameter — returns item(s) matching the specified status value. | |
| generic_tool_id | Yes | URL path parameter — unique identifier for the Generic Tool | |
| filters__overdue | No | Query string parameter — if true, returns item(s) that are overdue. | |
| filters__closed_at | No | Query string parameter — returns item(s) closed within the specified ISO 8601 datetime range. | |
| filters__issued_at | No | Query string parameter — returns item(s) issued within the specified ISO 8601 datetime range. | |
| filters__vendor_id | No | Query string parameter — return item(s) with the specified Vendor 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__recycle_bin | No | Query string parameter — if true, returns item(s) that have been deleted. | |
| filters__created_by_id | No | Query string parameter — returns item(s) created by the specified User IDs. | |
| filters__received_from_id | No | Query string parameter — filter results by received from id | |
| filters__login_information_id | No | Query string parameter — array of Login Information IDs. Returns item(s) with the specified Login Information ID. |