GET /rest/v1.0/projects/{project_id}/schedule/calendar_items
Returns all Calendar Items for a given project.
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
project_id |
Integer | Yes |
Unique identifier for the project. |
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 |
---|---|---|---|
page |
Integer | No |
Page |
start_date |
String | No |
Calendar Items that occur after this date |
per_page |
Integer | No |
Elements per page |
sort |
String | No |
Return item(s) with the specified sort. Prepend "-" to specify descending order. Possible values:
|
filtersupdated_at |
String | No |
Return item(s) last updated within the specified ISO 8601 datetime range.
Formats:
|
filtersdate |
String | No |
Returns task(s) existing on the specified ISO 8601 datetime |
filtersassigned_id[] |
Array | No |
Returns task(s) with specified assignee(s) |
view |
String | No |
The view to use when serializing Calendar Item data. The ids_only view returns an array of Calendar Item IDs. The total_count_only view returns total count of Calendar Items. Possible values:
|
filtersquery |
String | No |
Return item(s) containing search query |
finish_date |
String | No |
Calendar Items that occur before this date |
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.