List Change Events
list_change_eventsRead-onlyIdempotent
List change events for a project to obtain a paginated overview, find IDs, or filter by dates, status, budget, and other criteria.
Instructions
List Change Events. Use this to enumerate Change Events when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Change Events. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API (v1.1): Construction Financials > Change Events. Endpoint: GET /rest/v1.1/change_events
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | Query string 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__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__include_deleted | No | Query string parameter — use 'only' to return only deleted resources. Use 'with' to return deleted and undeleted resources. | |
| budget_change | No | JSON request body field — return Change Events with or without Change Items with the specified Budget Change | |
| budget_days_in_stage | No | JSON request body field — return Change Events with Change Items having the specified budget days in stage | |
| budget_stage_status | No | JSON request body field — return Change Events with Change Items having Budget Stage with the specified status | |
| budget_stage | No | JSON request body field — return Change Events with Change Items having Budget Stage with the specified stage | |
| budget_code | No | JSON request body field — return Change Events with or without Change Items with the specified Budget Code | |
| change_event_line_item | No | JSON request body field — change_event_line_item | |
| change_reason | No | JSON request body field — return Change Events with the specified Change Reason, or Change Events that do not have the specified Change Reason, based on the operator used | |
| change_type | No | JSON request body field — return Change Events with the specified Change Type, or Change Events that do not have the specified Change Type, based on the operator used. | |
| commitment_status | No | JSON request body field — return Change Events with Change Items having Commitment Contract or Commitment Change Order with the specified status | |
| commitment | No | JSON request body field — return Change Events with or without Change Items associated with a Commitment or Commitment Change Orders | |
| custom_field_id | No | JSON request body field — return Change Events with custom fields that match the specified custom field values | |
| created_at | No | JSON request body field — change Events created within the specified ISO 8601 datetime range. Formats: - `N_months` - Within N month, - `N_days` - Within N days, - `YYYY-MM-DD`...`YYYY-MM-DD` - Date, - `YYYY-MM-DDTHH:MM:SSZ... | |
| cost_in_status_since | No | JSON request body field — change Events with Change Items having cost entered status within the specified ISO 8601 datetime range. Formats: - `N_months` - Within N month, - `N_days` - Within N days, - `YYYY-MM-DD`...`YYYY-M... | |
| revenue_in_status_since | No | JSON request body field — change Events with Change Items having revenue entered status within the specified ISO 8601 datetime range. Formats: - `N_months` - Within N month, - `N_days` - Within N days, - `YYYY-MM-DD`...`YYY... | |
| budget_in_status_since | No | JSON request body field — change Events with Change Items having budget entered status within the specified ISO 8601 datetime range. Formats: - `N_months` - Within N month, - `N_days` - Within N days, - `YYYY-MM-DD`...`YYYY... | |
| created_by | No | JSON request body field — return Change Events created by the specified User | |
| commitment_title | No | JSON request body field — return Change Events with Change Items having Commitment or Commitment Change Orders with the specified title | |
| contract | No | JSON request body field — return Change Events with Change Items having Commitment or Commitment Change Orders with the specified Contract | |
| cost_days_in_stage | No | JSON request body field — return Change Events with Change Items having the specified cost days in stage | |
| cost_rom_amount | No | JSON request body field — return Change Events with Change Items having the specified cost rom amount | |
| latest_cost_amount_project_currency | No | JSON request body field — return Change Events with Change Items having the specified latest cost amount in project currency | |
| latest_revenue_amount_project_currency | No | JSON request body field — return Change Events with Change Items having the specified latest revenue amount in project currency | |
| latest_budget_impact_project_currency | No | JSON request body field — return Change Events with Change Items having the specified latest budget impact in project currency | |
| revenue_unit_cost_project_currency | No | JSON request body field — return Change Events with Change Items having the specified revenue unit cost in project currency |