List Correspondence Type Items
list_correspondence_type_itemsFetch a paginated list of correspondence type items for a project. Use filters to narrow results by ID, status, date, or other criteria.
Instructions
Returns a list of all Correspondence Type Items in the specified Project. For more information on Generic Tool and Correspondence Tool endpoints, see Working with the Correspondence Tool. Use this to enumerate Custom - Configurable Tools when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Custom - Configurable Tools. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API: Company Admin > Custom - Configurable Tools. Endpoint: GET /rest/v1.0/projects/{project_id}/correspondence_type_items
Input 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__login_information_id | No | Query string parameter — array of Login Information IDs. Returns item(s) with the specified Login Information ID. | |
| filters__status | No | Query string parameter — returns item(s) matching the specified status value. | |
| filters__overdue | No | Query string parameter — if true, returns item(s) that are overdue. | |
| filters__query | No | Query string parameter — return item(s) containing search query | |
| filters__recycle_bin | No | Query string parameter — if true, returns item(s) that have been deleted. | |
| filters__generic_tool_id | No | Query string parameter — return item(s) within the specified Generic Tool ID(s) | |
| filters__received_from_id | No | Query string parameter — filter results by received from id | |
| filters__created_by_id | No | Query string parameter — returns item(s) created by the specified User IDs. | |
| 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. | |
| 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__private | No | Query string parameter — if true, returns only item(s) with a `private` status. | |
| filters__location_id | No | Query string parameter — filters by specific location (Note: Use *either* this or location_id_with_sublocations, but not both) | |
| 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 | |
| group | No | Query string parameter — controls if the Items are returned sorted by the sort attribute then the Generic Tool's Title or just the sort attribute. Defaults to 'generic_tool_title'. | |
| view | No | Query string parameter — defines the type of view returned. Must be one of 'extended', 'compact', 'ids_only', or 'flatten_v0'. |