List Project Segment Items
list_project_segment_itemsRead-onlyIdempotent
Retrieve paginated Work Breakdown Structure records for a project segment. Filter by legacy cost code, sub job, or active status to find specific items.
Instructions
List Segment Items for a specific segment. 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, segment_id. Procore API: Construction Financials > Work Breakdown Structure. Endpoint: GET /rest/v1.0/projects/{project_id}/work_breakdown_structure/segments/{segment_id}/segment_items
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | URL path parameter — unique identifier for the project. | |
| segment_id | Yes | URL path parameter — unique identifier of the segment | |
| legacy_sub_job_id | No | Query string parameter — used to filter legacy cost codes by sub job. Default will filter by project. | |
| legacy_cost_code_id | No | Query string parameter — unique identifier of the legacy cost code | |
| include_action_policy | No | Query string parameter — include_action_policy | |
| only_active_items | No | Query string parameter — the only active items for this Work Breakdown Structure operation | |
| with_descendant_counts | No | Query string parameter — with_descendant_counts | |
| include_sub_job_cost_codes | No | Query string parameter — include_sub_job_cost_codes | |
| with_sub_job_cost_codes_count | No | Query string parameter — used to include the count of cost codes that can be used to create wbs codes for each sub job. ONLY supported by sub jobs. | |
| 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) |