List Project WBS Codes
list_project_wbs_codesRead-onlyIdempotent
Enumerate paginated Work Breakdown Structure codes for a project. Filter by status, updated date, scope, or group by contract.
Instructions
All Work Breakdown Structure codes for a given project. Use this to enumerate Work Breakdown Structure records when you need a paginated overview, to find IDs, or to filter by query parameters. Returns a paginated JSON array of Work Breakdown Structure records. Use page and per_page to control pagination; the response includes pagination metadata. Required parameters: project_id. Procore API: Construction Financials > Work Breakdown Structure. Endpoint: GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/wbs_codes
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| can_select_divisions | No | Query string parameter — if true, will include WBS Codes with division segment items. Default is true. | |
| required_segments | No | Query string parameter — the required segments for this Work Breakdown Structure operation | |
| filters__status__ | No | Query string parameter — filter results to only return codes with the included statuses. Options are 'active' or 'inactive'. Defaults to returning all results. | |
| filters__updated_at | No | Query string parameter — filter results to only return codes that were updated within the range of the two specified ISO 8601 timestamps separated by the ... delimiter. | |
| scope | No | Query string parameter — filter results to only return codes that match the specified WBS scope. | |
| query | No | Query string parameter — searches the WBS code and description values and returns results sorted in descending order of relevance to the search query. | |
| group_type | No | Query string parameter — along with 'group_id', groups WBS codes by the specified group type and group ID. Only supported option is 'contract'. | |
| group_id | No | Query string parameter — 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 | No | Query string parameter — 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 ... | |
| page | No | Query string parameter — page number for paginated results (default: 1) | |
| per_page | No | Query string parameter — number of items per page (default: 100, max: 100) |