GET /rest/v1.0/companies/{company_id}/schedule/summary
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.
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
company_id |
Integer | Yes |
Unique identifier for the company. |
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_stage_ids[] |
Array | No |
Filter by project stage IDs |
sort_key |
String | No |
Sort results by a property of projects. Defaults to descending project_event_count. Possible values:
|
project_department_ids[] |
Array | No |
Filter by project department IDs |
resource_ids[] |
Array | No |
Filter by resource IDs |
before |
String | Yes |
End of date range to filter by |
limit_per_day |
Integer | No |
Number of results to return per day Default value: 4 |
project_region_ids[] |
Array | No |
Filter by project region IDs |
program_ids[] |
Array | No |
Filter by project program IDs |
sort_dir |
String | No |
Sort results in ascending or descending order Possible values:
|
project_type_ids[] |
Array | No |
Filter by project type IDs |
after |
String | Yes |
Beginning of date range to filter by. |
project_owner_type_ids[] |
Array | No |
Filter by project owner type IDs |
project_ids[] |
Array | No |
Filter by project IDs |
project_office_ids[] |
Array | No |
Filter by project office IDs |
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.