GET /rest/v1.0/workforce-planning/v2/companies/{company_id}/groups/{group_id}/assignments

Returns the Resource Planning Assignment data for the given company and group

Servers

Path parameters

Name Type Required Description
company_id Yes

Unique identifier for the company. This parameter accepts both formats:

  • Recommended: Procore company ID (integer) - Use this for new integrations
  • Legacy: LaborChart UUID format (uuid string) - Supported for backward compatibility

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
page Integer No

This is a 0-based index representing the page slice of the data you want to retrieve. Each page contains up to 400 items.

📌 Pageable Endpoints People endpoints that return multiple records support pagination. It is recommended to use this feature to prevent network timeouts from excessively large data requests.

📌 Response Structure A successful response will include the following properties:

  • possible_pages (integer) → Total number of pages available to retrieve all data. - current_page (integer) → The 0-based index of the page retrieved. - data (array) → List of records returned for the requested page (up to 400 items per page). If a page value exceeds possible_pages, the data property will return an empty array.
dayRange String Yes

A value specifying how many days forward you would like to get assignments for from the specified startDay. Assignments whose start_day falls within the given range will be returned in the response. The startDay parameter in conjunction with the dayRange parameter will create a range of dates that will filter each assignment based on its start_day field. For example, passing in a startDay of 2024-01-01 and a dayRange of 1 will return all assignments that begin on either the 1st or 2nd of January. If we pass in the same startDay, but with a dayRange of 15, the results will include all assignments whose start_day exists between the dates of 2024-01-01 and 2024-01-15. Max value is 365.

start_day String Yes

The starting day to filter assignments by.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.