GET /rest/v1.0/workforce-planning/v2/companies/{company_id}/groups/{group_id}/reports/look-ahead
Fetches the Look Ahead report which provides future assignments and availability details for People within a specified Group. To span all Groups in the company, use "all"
in place of {group_id}
.
Servers
- https://api.procore.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
company_id |
Yes |
Unique identifier for the company. This parameter accepts both formats:
A proxy layer automatically handles both formats, but using the Procore company ID is preferred for consistency with other Procore APIs. |
|
group_id |
Integer | Yes |
Unique identifier for the group |
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 |
---|---|---|---|
projectName |
Boolean | No |
Whether to include the project name for each assignment. Default value: true |
jobTitleIds[] |
Array | No |
An array of UUIDs representing the Job Titles to include in the report. People with Job Titles not in this list will be excluded. |
assignmentDuration |
Boolean | No |
Whether to include a calculated duration for each assignment. Default value: true |
availableAfterDate |
Boolean | No |
Whether to include the last day a person is assigned in the future. Default value: true |
assignmentCount |
Integer | No |
The number of future assignments to return per person. Possible values:
Default value: 3 |
assignmentStart |
Boolean | No |
Whether to include the assignment start date. Default value: true |
employee_number |
String | No |
Filter results by the exact employee number of the Person. |
jobTitle |
Boolean | No |
Whether to include the person's Job Title. Default value: true |
project_number |
String | No |
Filters items by their exact project number. The query performs an exact match. Example usage: |
assignmentEnd |
Boolean | No |
Whether to include the assignment end date. Default value: true |
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.