Procore WBS Segment Item Lists API

openapi: 3.2.0
info:
  title: Procore REST WBS Segment Item Lists API
  version: v1.0/v2.0
  description: Merged from the per-resource OpenAPI documents Procore publishes through its developer portal (https://developers.procore.com/api/v1/resource_groups). Originals are kept verbatim in openapi/_original/resources/.
  x-source: https://developers.procore.com/api/v1/resource_groups
servers:
- url: https://api.procore.com
  description: Production
security:
- bearerAuth: []
tags:
- name: WBS Segment Item Lists
paths:
  /rest/v1.0/companies/{company_id}/work_breakdown_structure/segments/{segment_id}/lists:
    parameters:
    - name: Procore-Company-Id
      in: header
      description: Unique company identifier associated with the Procore User Account.
      required: true
      schema:
        type: integer
    - name: company_id
      in: path
      description: Unique identifier for the company.
      required: true
      schema:
        type: integer
    - name: segment_id
      in: path
      description: ID of the WBS Segment whose Segment Item Lists to retrieve. Only cost_code and line_item_type segment types are supported; other segment types return an empty array. Retrieve valid segment IDs from segments[].id in the GET patterns response.
      required: true
      schema:
        type: integer
    x-compliance-level: partial
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: List Company WBS Segment Item Lists
      description: List Segment Item Lists for a specific segment
      tags:
      - WBS Segment Item Lists
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  description: A WBS Segment Item List — a named collection of segment items (cost codes or cost types) that can be assigned to a WBS Segment. For cost_code segments this corresponds to a Standard Cost Code List; for line_item_type segments these are fixed system lists (Procore Cost Types and, when ERP-integrated, ERP Cost Types).
                  properties:
                    id:
                      type: integer
                      description: Unique identifier for this Segment Item List. For cost_code segments, this is the Standard Cost Code List ID. For line_item_type segments, 1 = Procore Cost Types (non-ERP) and 2 = ERP Cost Types.
                      example: 12345
                    name:
                      type: string
                      description: Display name of the Segment Item List (e.g. 'Procore Standard Cost Codes' or 'Procore Cost Types'). Shown in the WBS Admin UI when selecting a list for a segment.
                      example: Procore Cost Types
                    segment_items_count:
                      type: integer
                      description: Total number of segment items (cost codes or cost types) contained in this list.
                      example: 48
                    erp_integrated:
                      type: boolean
                      description: Whether this list is linked to an ERP integration. When true, the segment items in this list are managed by the connected ERP system and cannot be freely edited in Procore.
                      example: false
                    available_to_use_on_new_projects:
                      type: boolean
                      description: Whether this list is available to be assigned to new projects. When true, it can be selected during project creation or project-level WBS configuration.
                      example: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                  message:
                    type: string
                  fields:
                    type: string
                  reason:
                    description: A human-readable code providing additional detail on the cause of the error.
                    type: string
                  error:
                    description: Description of the error thrown.
                    type:
                    - string
                    - 'null'
                    example: Invalid Token
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                  message:
                    type: string
                  fields:
                    type: string
                  reason:
                    description: A human-readable code providing additional detail on the cause of the error.
                    type: string
                  error:
                    description: Description of the error thrown.
                    type:
                    - string
                    - 'null'
                    example: Invalid Token
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    format: int32
                  message:
                    type: string
                  fields:
                    type: string
                  reason:
                    description: A human-readable code providing additional detail on the cause of the error.
                    type: string
                  error:
                    description: Description of the error thrown.
                    type:
                    - string
                    - 'null'
                    example: Invalid Token
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  exception:
                    type: string
      x-code-samples:
      - id: node_request
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'GET',\n  url: 'https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/work_breakdown_structure/segments/%7Bsegment_id%7D/lists'\n};\n\nrequest(options, function (error, response, body) {\n  if (error) throw new Error(error);\n\n  console.log(body);\n});\n"
      - id: python_python3
        title: Python3
        content: 'import http.client


          conn = http.client.HTTPSConnection("api.procore.com")


          conn.request("GET", "/rest/v1.0/companies/%7Bcompany_id%7D/work_breakdown_structure/segments/%7Bsegment_id%7D/lists")


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        title: Curl
        content: "curl --request GET \\\n  --url https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/work_breakdown_structure/segments/%7Bsegment_id%7D/lists"
      - id: csharp_httpclient
        title: C#
        content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n    Method = HttpMethod.Get,\n    RequestUri = new Uri(\"https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/work_breakdown_structure/segments/%7Bsegment_id%7D/lists\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n    response.EnsureSuccessStatusCode();\n    var body = await response.Content.ReadAsStringAsync();\n    Console.WriteLine(body);\n}"
      x-rate-limit-enabled: true
      x-procore-kong-tags:
      - rate-limit:enabled
      operationId: listCompanyWbsSegmentItemLists
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer