GET /rest/v1.1/change_events
List Change Events.
Servers
- https://api.procore.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Procore-Company-Id |
Integer | Yes |
Unique company identifier associated with the Procore User Account. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
Page |
project_id |
Integer | Yes |
Unique identifier for the project. |
per_page |
Integer | No |
Elements per page |
filters[created_at] |
String | No |
Return item(s) created within the specified ISO 8601 datetime range.
Formats:
|
filters[updated_at] |
String | No |
Return item(s) last updated within the specified ISO 8601 datetime range.
Formats:
|
filters[include_deleted] |
String | No |
Use 'only' to return only deleted resources. Use 'with' to return deleted and undeleted resources. Valid values:
|
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
filters |
Object | No | |
filters.budget_unit_cost_value_project_currency |
Object | No |
Return Change Events with Change Items having the specified budget unit cost in project currency |
filters.budget_unit_cost_value_project_currency.id[] |
Array | No | |
filters.budget_unit_cost_value_project_currency.operator |
String | No |
Valid values:
|
filters.cost_stage_status |
Object | No |
Return Change Events with Change Items having Cost Stage with the specified status |
filters.cost_stage_status.id[] |
Array | No | |
filters.cost_stage_status.operator |
String | No |
Valid values:
|
filters.custom_field_id |
Object | No |
Return Change Events with custom fields that match the specified custom field values |
filters.custom_field_id.id[] |
Array | No | |
filters.custom_field_id.operator |
String | No |
Valid values:
|
filters.event_origin_type |
Object | No |
Return Change Events with or without the assigned Origin with specified Origin Type. |
filters.event_origin_type.id[] |
Array | No | |
filters.event_origin_type.operator |
String | No |
Valid values:
|
filters.change_reason |
Object | No |
Return Change Events with the specified Change Reason, or Change Events that do not have the specified Change Reason, based on the operator used |
filters.change_reason.id[] |
Array | No | |
filters.change_reason.operator |
String | No |
Valid values:
|
filters.cost_in_status_since |
String | No |
Change Events with Change Items having cost entered status within the specified ISO 8601 datetime range. Formats:
|
filters.rfq_title |
Object | No |
Change Items having Request for Quote with title groups which are represented by the RFQ ID and Composed RFQ ID or None which is empty string |
filters.rfq_title.id[] |
Array | No | |
filters.scope |
Object | No |
Return Change Events with the specified event scope, or Change Events that do not have the specified event scope, based on the operator used |
filters.scope.id[] |
Array | No | |
filters.scope.operator |
String | No |
Valid values:
|
filters.over_under_project_currency |
Object | No |
Return Change Events with Change Items having the specified over/under amount in project currency (revenue - cost) |
filters.over_under_project_currency.id[] |
Array | No | |
filters.over_under_project_currency.operator |
String | No |
Valid values:
|
filters.budget_days_in_stage |
Object | No |
Return Change Events with Change Items having the specified budget days in stage |
filters.budget_days_in_stage.id[] |
Array | No | |
filters.budget_days_in_stage.operator |
String | No |
Valid values:
|
filters.latest_quote_amount_project_currency |
Object | No |
Return Change Events with Change Items having the specified request for quote amount in project currency |
filters.latest_quote_amount_project_currency.id[] |
Array | No | |
filters.latest_quote_amount_project_currency.operator |
String | No |
Valid values:
|
filters.cost_unit_cost_value_project_currency |
Object | No |
Return Change Events with Change Items having the specified cost unit cost in project currency |
filters.cost_unit_cost_value_project_currency.id[] |
Array | No | |
filters.cost_unit_cost_value_project_currency.operator |
String | No |
Valid values:
|
filters.budget_change |
Object | No |
Return Change Events with or without Change Items with the specified Budget Change |
filters.budget_change.id[] |
Array | No | |
filters.budget_change.operator |
String | No |
Valid values:
|
filters.wbs_segment_id |
Object | No |
Return Change Events with or without Change Items with Budget Code that has the specified WBS Segment ID |
filters.wbs_segment_id.id[] |
Array | No | |
filters.wbs_segment_id.operator |
String | No |
Valid values:
|
filters.commitment_status |
Object | No |
Return Change Events with Change Items having Commitment Contract or Commitment Change Order with the specified status |
filters.commitment_status.id[] |
Array | No | |
filters.prime_pco_status |
Object | No |
Return Change Events with Change Items having Prime Change Order with the specified status |
filters.prime_pco_status.id[] |
Array | No | |
filters.created_by |
Object | No |
Return Change Events created by the specified User |
filters.created_by.id[] |
Array | No | |
filters.revenue_days_in_stage |
Object | No |
Return Change Events with Change Items having the specified revenue days in stage |
filters.revenue_days_in_stage.id[] |
Array | No | |
filters.revenue_days_in_stage.operator |
String | No |
Valid values:
|
filters.change_event_line_item |
Object | No | |
filters.change_event_line_item.id[] |
Array | No | |
filters.change_event_line_item.operator |
String | No |
Valid values:
|
filters.vendor |
Object | No |
Return Change Events with the ids of the specified Change Event Vendors |
filters.vendor.id[] |
Array | No | |
filters.vendor.operator |
String | No |
Valid values:
|
filters.latest_cost_amount_project_currency |
Object | No |
Return Change Events with Change Items having the specified latest cost amount in project currency |
filters.latest_cost_amount_project_currency.id[] |
Array | No | |
filters.latest_cost_amount_project_currency.operator |
String | No |
Valid values:
|
filters.cost_rom_amount |
Object | No |
Return Change Events with Change Items having the specified cost rom amount |
filters.cost_rom_amount.id[] |
Array | No | |
filters.cost_rom_amount.operator |
String | No |
Valid values:
|
filters.number |
Object | No |
Return Change Events with or without the specified Change Event ID |
filters.number.id[] |
Array | No | |
filters.number.operator |
String | No |
Valid values:
|
filters.commitment_title |
Object | No |
Return Change Events with Change Items having Commitment or Commitment Change Orders with the specified title |
filters.commitment_title.id[] |
Array | No | |
filters.commitment_title.operator |
String | No |
Valid values:
|
filters.budget_stage |
Object | No |
Return Change Events with Change Items having Budget Stage with the specified stage |
filters.budget_stage.id[] |
Array | No | |
filters.budget_stage.operator |
String | No |
Valid values:
|
filters.status |
Object | No |
Return Change Events with the specified status, or Change Events that do not have the specified status, based on the operator used |
filters.status.id[] |
Array | No | |
filters.status.operator |
String | No |
Valid values:
|
filters.budget_in_status_since |
String | No |
Change Events with Change Items having budget entered status within the specified ISO 8601 datetime range. Formats:
|
filters.latest_revenue_amount_project_currency |
Object | No |
Return Change Events with Change Items having the specified latest revenue amount in project currency |
filters.latest_revenue_amount_project_currency.id[] |
Array | No | |
filters.latest_revenue_amount_project_currency.operator |
String | No |
Valid values:
|
filters.non_commitment |
Object | No |
Return Change Events with or without Change Items with Non Commitment Cost |
filters.non_commitment.id[] |
Array | No | |
filters.non_commitment.operator |
String | No |
Valid values:
|
filters.prime_pco |
Object | No |
Return Change Events with or without Change Items associated with Prime PCO |
filters.prime_pco.id[] |
Array | No | |
filters.prime_pco.operator |
String | No |
Valid values:
|
filters.contract |
Object | No |
Return Change Events with Change Items having Commitment or Commitment Change Orders with the specified Contract |
filters.contract.id[] |
Array | No | |
filters.contract.operator |
String | No |
Valid values:
|
filters.rfq_status |
Object | No |
Return Change Events with Change Items having Request for Quote with the specified status |
filters.rfq_status.id[] |
Array | No | |
filters.cost_days_in_stage |
Object | No |
Return Change Events with Change Items having the specified cost days in stage |
filters.cost_days_in_stage.id[] |
Array | No | |
filters.cost_days_in_stage.operator |
String | No |
Valid values:
|
filters.rfq |
Object | No |
Return Change Events with or without Change Items having Request for Quote |
filters.rfq.id[] |
Array | No | |
filters.rfq.operator |
String | No |
Valid values:
|
filters.cost_stage |
Object | No |
Return Change Events with Change Items having Cost Stage with the specified stage |
filters.cost_stage.id[] |
Array | No | |
filters.cost_stage.operator |
String | No |
Valid values:
|
filters.commitment |
Object | No |
Return Change Events with or without Change Items associated with a Commitment or Commitment Change Orders |
filters.commitment.id[] |
Array | No | |
filters.commitment.operator |
String | No |
Valid values:
|
filters.number_title |
Object | No |
Return Change Events with or without the specified Change Event ID |
filters.number_title.id[] |
Array | No | |
filters.number_title.operator |
String | No |
Valid values:
|
filters.production_quantity |
Object | No | |
filters.production_quantity.id[] |
Array | No | |
filters.production_quantity.operator |
String | No |
Valid values:
|
filters.revenue_rom_amount_project_currency |
Object | No |
Return Change Events with Change Items having the specified revenue rom amount in project currency |
filters.revenue_rom_amount_project_currency.id[] |
Array | No | |
filters.revenue_rom_amount_project_currency.operator |
String | No |
Valid values:
|
filters.revenue_in_status_since |
String | No |
Change Events with Change Items having revenue entered status within the specified ISO 8601 datetime range. Formats:
|
filters.revenue_unit_cost_project_currency |
Object | No |
Return Change Events with Change Items having the specified revenue unit cost in project currency |
filters.revenue_unit_cost_project_currency.id[] |
Array | No | |
filters.revenue_unit_cost_project_currency.operator |
String | No |
Valid values:
|
filters.item_type |
Object | No |
Return Change Events with Change Items having the specified Item Type |
filters.item_type.id[] |
Array | No | |
filters.item_type.operator |
String | No |
Valid values:
|
filters.budget_rom_amount_project_currency |
Object | No |
Return Change Events with Change Items having the specified budget rom amount in project currency |
filters.budget_rom_amount_project_currency.id[] |
Array | No | |
filters.budget_rom_amount_project_currency.operator |
String | No |
Valid values:
|
filters.created_at |
String | No |
Change Events created within the specified ISO 8601 datetime range. Formats:
|
filters.budget_stage_status |
Object | No |
Return Change Events with Change Items having Budget Stage with the specified status |
filters.budget_stage_status.id[] |
Array | No | |
filters.budget_stage_status.operator |
String | No |
Valid values:
|
filters.change_type |
Object | No |
Return Change Events with the specified Change Type, or Change Events that do not have the specified Change Type, based on the operator used. |
filters.change_type.id[] |
Array | No | |
filters.change_type.operator |
String | No |
Valid values:
|
filters.latest_budget_impact_project_currency |
Object | No |
Return Change Events with Change Items having the specified latest budget impact in project currency |
filters.latest_budget_impact_project_currency.id[] |
Array | No | |
filters.latest_budget_impact_project_currency.operator |
String | No |
Valid values:
|
filters.budget_code |
Object | No |
Return Change Events with or without Change Items with the specified Budget Code |
filters.budget_code.id[] |
Array | No | |
filters.budget_code.operator |
String | No |
Valid values:
|
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.