GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/wbs_codes
All Work Breakdown Structure codes 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 |
can_select_divisions |
Boolean | No |
If true, will include WBS Codes with division segment items. Default is true. |
query |
String | No |
Searches the WBS code and description values and returns results sorted in descending order of relevance to the search query. |
required_segments[] |
Array | No | |
filtersstatus[] |
Array | No |
Filter results to only return codes with the included statuses. Options are 'active' or 'inactive'. Defaults to returning all results. |
per_page |
Integer | No |
Elements per page |
filtersupdated_at |
String | No |
Filter results to only return codes that were updated within the range of the two specified ISO 8601 timestamps separated by the ... delimiter. |
scope |
String | No |
Filter results to only return codes that match the specified WBS scope. Possible values:
|
group_type |
String | No |
Along with 'group_id', groups WBS codes by the specified group type and group ID. Only supported option is 'contract'. Possible values:
|
group_id |
Integer | No |
Along with 'group_type', groups WBS codes by the specified group type and group ID. Only supported option is a contract ID. |
hide_not_in_group |
Boolean | No |
If true, will hide WBS codes that are not in the specified 'group_type' and 'group_id'. Default is true. If false, WBS codes in the specified group will be returned first followed by WBS codes not in the group. |
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.