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

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
project_id Integer Yes

Unique identifier for the project.

filterspriority String No

Return item(s) with the specified Punch Item Priority - 'low', 'medium', 'high'

Possible values:

  • "medium"
  • "low"
  • "high"
filtersapprover_login_information_id Integer No

User ID. Returns item(s) where the specified User ID is an approver.

filterslocation_id[] Array No

Location ID. Returns item(s) with the specified Location ID or a range of Location IDs.

page Integer No

Page

filtersassignee_response Boolean No

If true, returns item(s) with the specified assignee response approved status.

Default value: false

filtersvendor_id Integer No

Return item(s) with the specified Vendor ID.

per_page Integer No

Elements per page

filtersstatus String No

Return item(s) with the specified Punch Item Status - 'open' or 'closed'.

Possible values:

  • "open"
  • "closed"
  • "pending"
filterspunch_item_type_id Integer No

Return item(s) with the specified Punch Item Type ID.

filtersupdated_at String No

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 YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00 - Datetime with Custom Offset

filtersinclude_sublocations Boolean No

Use together with filters[location_id]

Default value: false

filtersid[] Array No

Return item(s) with the specified Punch Item ID.

filterstrade_id Integer No

Trade ID

filtersquery String No

Return item(s) containing search query

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.