Return Company Schedule Summary
return_company_schedule_summaryRetrieve the number of tasks and calendar items per project for each day within a specified date range. Useful for reviewing schedule summaries across projects.
Instructions
Returns a list of the number of tasks and calendar items per project for each day in the specified date range. Tasks and calendar items whose start - finish overlap with the specified date range are included in the sums. Use this to read information about Company Settings from Procore. Returns a paginated JSON array of Company Settings. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: company_id, after, before. Procore API: Company Admin > Company Settings. Endpoint: GET /rest/v1.0/companies/{company_id}/schedule/summary
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | Yes | URL path parameter — unique identifier for the company. | |
| after | Yes | Query string parameter — beginning of date range to filter by. | |
| before | Yes | Query string parameter — end of date range to filter by | |
| limit_per_day | No | Query string parameter — number of results to return per day | |
| project_ids | No | Query string parameter — filter by project IDs | |
| project_stage_ids | No | Query string parameter — filter by project stage IDs | |
| project_type_ids | No | Query string parameter — filter by project type IDs | |
| project_department_ids | No | Query string parameter — filter by project department IDs | |
| project_office_ids | No | Query string parameter — filter by project office IDs | |
| project_region_ids | No | Query string parameter — filter by project region IDs | |
| project_owner_type_ids | No | Query string parameter — filter by project owner type IDs | |
| program_ids | No | Query string parameter — filter by project program IDs | |
| resource_ids | No | Query string parameter — filter by resource IDs | |
| sort_key | No | Query string parameter — sort results by a property of projects. Defaults to descending project_event_count. | |
| sort_dir | No | Query string parameter — sort results in ascending or descending order | |
| page | No | Page number for paginated results (default: 1) | |
| per_page | No | Number of items per page (default: 100, max: 100) |