Procore Body Parts API

openapi: 3.2.0
info:
  title: Procore REST Body Parts 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: Body Parts
paths:
  /rest/v1.0/companies/{company_id}/incidents/body_parts:
    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
    x-compliance-level: full
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: List Body Parts
      description: Returns a paginated list of all body parts available for associating with incident injuries. Supports filtering by selectable status.
      tags:
      - Body Parts
      parameters:
      - name: page
        in: query
        description: Page
        schema:
          type: integer
      - name: per_page
        in: query
        description: Elements per page
        schema:
          type: integer
      - name: filters[selectable]
        in: query
        description: If true, return item(s) with 'selectable' status.
        schema:
          type: boolean
      - name: filters[id]
        in: query
        description: Return item(s) with the specified IDs.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
      - name: filters[updated_at]
        in: query
        description: 'Return item(s) last updated within the specified ISO 8601 datetime range.

          Formats:

          `YYYY-MM-DD`...`YYYY-MM-DD` - Date

          `YYYY-MM-DDTHH:MM:SSZ`...`YYYY-MM-DDTHH:MM:SSZ` - DateTime with UTC Offset

          `YYYY-MM-DDTHH:MM:SS+XX:00`...`YYYY-MM-DDTHH:MM:SS+XX:00` - Datetime with Custom Offset'
        required: false
        schema:
          type: string
          format: date
      - name: sort
        in: query
        description: Sort results by the specified field.
        schema:
          type: string
          enum:
          - name
      responses:
        '200':
          description: OK
          headers:
            Per-Page:
              description: Number of items retrieved per page
              schema:
                type: integer
            Total:
              description: Total number of items to be retrieved
              schema:
                type: integer
            Link:
              description: Link headers for the first, prev, next, and last link
              schema:
                type: string
          content:
            application/json:
              schema:
                type: array
                description: Array of Body Parts
                items:
                  type: object
                  title: Body Part
                  properties:
                    id:
                      type: integer
                      description: Unique identifier for this body part entry.
                      example: 999
                    name:
                      type: string
                      description: Machine-readable name of the body part (e.g. finger_index_right, shoulder_left). Use this value when associating body parts to injuries.
                      example: finger_index_right
                    selectable:
                      type: boolean
                      description: Represents whether a Body Part can be associated to an injury.
                      example: true
                    created_at:
                      type: string
                      description: ISO 8601 timestamp of when this body part record was created.
                      format: date-time
                      example: '2016-10-25T17:53:35Z'
                    updated_at:
                      type: string
                      description: ISO 8601 timestamp of the most recent update to this body part record.
                      format: date-time
                      example: '2016-10-25T17:53:35Z'
                    parent_id:
                      type:
                      - integer
                      - 'null'
                      description: Identifier of the parent body part in the anatomical hierarchy. Null for top-level body parts (e.g. hand is parent of finger).
                      example: 999
        '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
      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/incidents/body_parts',\n  qs: {\n    page: 'SOME_INTEGER_VALUE',\n    per_page: 'SOME_INTEGER_VALUE',\n    'filters[selectable]': 'SOME_BOOLEAN_VALUE',\n    'filters[id]': 'SOME_ARRAY_VALUE',\n    'filters[updated_at]': 'SOME_STRING_VALUE',\n    sort: 'SOME_STRING_VALUE'\n  },\n  headers: {Authorization: 'Bearer REPLACE_BEARER_TOKEN'}\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")


          headers = { ''Authorization'': "Bearer REPLACE_BEARER_TOKEN" }


          conn.request("GET", "/rest/v1.0/companies/%7Bcompany_id%7D/incidents/body_parts?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bselectable%5D=SOME_BOOLEAN_VALUE&filters%5Bid%5D=SOME_ARRAY_VALUE&filters%5Bupdated_at%5D=SOME_STRING_VALUE&sort=SOME_STRING_VALUE", headers=headers)


          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/incidents/body_parts?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bselectable%5D=SOME_BOOLEAN_VALUE&filters%5Bid%5D=SOME_ARRAY_VALUE&filters%5Bupdated_at%5D=SOME_STRING_VALUE&sort=SOME_STRING_VALUE' \\\n  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"
      - 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/incidents/body_parts?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bselectable%5D=SOME_BOOLEAN_VALUE&filters%5Bid%5D=SOME_ARRAY_VALUE&filters%5Bupdated_at%5D=SOME_STRING_VALUE&sort=SOME_STRING_VALUE\"),\n    Headers =\n    {\n        { \"Authorization\", \"Bearer REPLACE_BEARER_TOKEN\" },\n    },\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: listBodyParts
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer