GET /rest/v1.0/punch_items
Return a list of all Punch Items for a specified Project.
See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.
Servers
- https://api.procore.com
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 |
|---|---|---|---|
filters[trade_id] |
Integer | No |
Trade ID |
project_id |
Integer | Yes |
Unique identifier for the project. |
filters[punch_item_type_id] |
Integer | No |
Return item(s) with the specified Punch Item Type ID. |
filters[assignee_response] |
Boolean | No |
If true, returns item(s) with the specified assignee response approved status. Default value: false |
filters[status] |
String | No |
Return item(s) with the specified Punch Item Status - 'open' or 'closed'. Possible values:
|
filters[location_id][] |
Array | No |
Location ID. Returns item(s) with the specified Location ID or a range of Location IDs. |
page |
Integer | No |
Page |
filters[priority] |
String | No |
Return item(s) with the specified Punch Item Priority - 'low', 'medium', 'high' Possible values:
|
filters[id][] |
Array | No |
Return item(s) with the specified Punch Item ID. |
per_page |
Integer | No |
Elements per page |
filters[vendor_id] |
Integer | No |
Return item(s) with the specified Vendor ID. |
filters[updated_at] |
String | No |
Return item(s) last updated within the specified ISO 8601 datetime range.
Formats:
|
filters[include_sublocations] |
Boolean | No |
Use together with Default value: false |
filters[approver_login_information_id] |
Integer | No |
User ID. Returns item(s) where the specified User ID is an approver. |
filters[query] |
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.