Get Company Snapshots Summary
get_company_snapshots_summaryRead-onlyIdempotent
Retrieve a paginated summary of budget snapshots for a company by budget view ID. Filter by project, status, program, region, stage, office, department, creator, or date range.
Instructions
Returns a summary of all selected snapshots for a company. Use this to fetch the full details of a specific Budget records by its identifier. Returns a paginated JSON array of Budget records. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: company_id, budget_view_id. Procore API (v2.0): Construction Financials > Budget. Endpoint: GET /rest/v2.0/companies/{company_id}/budget_views/{budget_view_id}/project_status_snapshots/summary
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| budget_view_id | Yes | URL path parameter — iD of the budget view | |
| filters__status_id | No | Query string parameter — filter snapshots by PSS custom status ID | |
| filters__project_id | No | Query string parameter — filter snapshots by project ID | |
| filters__program_id | No | Query string parameter — filter snapshots by program ID | |
| filters__region_id | No | Query string parameter — filter snapshots by region ID | |
| filters__stage_id | No | Query string parameter — filter snapshots by stage ID | |
| filters__office_id | No | Query string parameter — filter snapshots by office ID | |
| filters__department_id | No | Query string parameter — filter snapshots by department ID | |
| filters__created_by_id | No | Query string parameter — filter snapshots by created_by_id | |
| filters__created_at | No | Query string parameter — filter snapshots by created_at date range, inclusive | |
| page | No | Page number for paginated results (default: 1) | |
| per_page | No | Number of items per page (default: 100, max: 100) |