Procore Company Checklist Template API

openapi: 3.2.0
info:
  title: Procore REST Company Checklist Template 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: Company Checklist Template
paths:
  /rest/v1.0/companies/{company_id}/checklist/list_templates/{id}:
    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: id
      in: path
      required: true
      description: Company Checklist Template ID
      schema:
        type: integer
    x-compliance-level: full
    delete:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Delete Company Checklist Template
      description: Delete a Company Checklist Template
      tags:
      - Company Checklist Template
      responses:
        '204':
          description: No Content
        '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:
                  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
        '422':
          description: Unprocessable Entity
          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: 'DELETE',\n  url: 'https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/checklist/list_templates/%7Bid%7D',\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("DELETE", "/rest/v1.0/companies/%7Bcompany_id%7D/checklist/list_templates/%7Bid%7D", headers=headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        title: Curl
        content: "curl --request DELETE \\\n  --url https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/checklist/list_templates/%7Bid%7D \\\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.Delete,\n    RequestUri = new Uri(\"https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/checklist/list_templates/%7Bid%7D\"),\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
      x-changelog:
      - summary: Added Company Checklist Template delete endpoint
        description: Delete a Company Checklist Template for a given Company ID.
        endpoint: DELETE /companies/{company_id}/checklist/list_templates/{id}
        type: new
        breaking: false
        datestamp: '2020-07-14'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: company-checklist-templates?version=1.0#delete-company-checklist-template
      operationId: deleteCompanyChecklistTemplate
  /rest/v1.0/companies/{company_id}/recycle_bin/checklist/list_templates/{id}:
    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: id
      in: path
      required: true
      description: Company Checklist Template ID
      schema:
        type: integer
    x-compliance-level: full
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Show Recycled Company Checklist Template
      description: View the details of a Recycled Company Checklist Template
      tags:
      - Company Checklist Template
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - title: Company Checklist Template
                  type: object
                  properties:
                    id:
                      type: integer
                      description: Unique identifier for the checklist template.
                      example: 142
                    name:
                      type: string
                      description: Name of the checklist template.
                      example: Window Inspection
                    description:
                      type: string
                      description: Description of the checklist template.
                      example: Checklist for windows
                    inspection_type:
                      type:
                      - object
                      - 'null'
                      title: Inspection Type
                      properties:
                        id:
                          type: integer
                          description: Unique identifier for the inspection type.
                          example: 142
                        name:
                          type: string
                          description: Name of the inspection type.
                          example: Safety Compliance
                        created_at:
                          type: string
                          format: date-time
                          description: Timestamp of creation
                          example: '2014-12-10T23:36:30Z'
                        updated_at:
                          type: string
                          format: date-time
                          description: Timestamp of last update
                          example: '2014-12-11T04:58:42Z'
                    trade:
                      type:
                      - object
                      - 'null'
                      title: Trade
                      properties:
                        id:
                          type: integer
                          description: Trade ID
                          example: 999
                        name:
                          type: string
                          description: Trade name
                          example: 09 - acoustical panels
                        active:
                          type: boolean
                          description: Trade availability
                          example: true
                        updated_at:
                          type: string
                          format: date-time
                          description: Timestamp of last update to Trade
                          example: '2016-08-01T23:33:54Z'
                    created_at:
                      type: string
                      format: date-time
                      description: Timestamp of creation
                      example: '2014-12-10T23:36:30Z'
                    updated_at:
                      type: string
                      format: date-time
                      description: Timestamp of last update
                      example: '2014-12-11T04:58:42Z'
                    broken_config:
                      type: boolean
                      description: Indicates whether the template has an invalid configuration because an item requirement or display condition references a response option or status that its response set does not provide. When true, update the affected items or response sets before using the template.
                      example: false
                - type: object
                  properties:
                    alternative_response_set_id:
                      type:
                      - integer
                      - 'null'
                      description: The ID of the associated Alternative Response Set (if null, the default response set is being used)
                      example: 12
                    created_by:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Unique identifier of the user who created the template.
                          example: 160586
                        login:
                          type: string
                          description: Email
                          example: exampleuser@example.com
                        name:
                          type: string
                          description: Name
                          example: Carl Contractor
                    attachments:
                      type: array
                      description: Attachments
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            description: Unique identifier for the attachment.
                            example: 5324
                          url:
                            type: string
                            description: URL of the attachment.
                            example: http://www.example.com/
                          filename:
                            type: string
                            description: Filename of the attachment.
                            example: january_receipt_copy.jpg
                    response_set:
                      title: ChecklistDefaultResponseSet
                      type: object
                      properties:
                        conforming_response:
                          type: string
                          description: Term used to represent conforming statuses on items within the current template, e.g. "Pass" or "Safe". This maps to an item status of "yes".
                          example: Pass
                        deficient_response:
                          type: string
                          description: Term used to represent deficient statuses on items within the current template, e.g. "Fail" or "At Risk".  This maps to an item status of "no".
                          example: Fail
                        global:
                          type: boolean
                          description: Represents whether a response set has been provided by Procore.
                          example: true
                    sections:
                      type: array
                      description: Sections
                      items:
                        allOf:
                        - title: Checklist Template Section
                          type: object
                          properties:
                            id:
                              type: integer
                              description: Unique identifier for the checklist section.
                              example: 142
                            name:
                              type: string
                              description: Name of the checklist section.
                              example: Fall Protection and Perimeter Protection
                            position:
                              type: integer
                              description: Sort position of the section within its checklist template.
                              example: 2
                        - type: object
                          properties:
                            items:
                              type: array
                              items:
                                allOf:
                                - title: Checklist Template Item
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      description: Unique identifier for the checklist item.
                                      example: 2
                                    name:
                                      type: string
                                      description: Name of the checklist item.
                                      example: Item 1
                                    section_id:
                                      type: integer
                                      description: Checklist Template Section ID
                                      example: 21
                                    position:
                                      type: integer
                                      description: Sort position of the item within its section.
                                      example: 1
                                    response_set:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                          description: ID of the response set
                                          example: 83
                                        name:
                                          type: string
                                          description: Name of the response set
                                          example: Safety Responses
                                        responses:
                                          type: array
                                          items:
                                            title: ChecklistResponse
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                                description: ID
                                                example: 1
                                              name:
                                                type: string
                                                description: The name of the Response
                                                example: Safe - Knowledge
                                              corresponding_status:
                                                type: string
                                                description: Corresponding Checklist Item status
                                                enum:
                                                - 'yes'
                                                - 'no'
                                                - n/a
                                                - none
                                                example: 'yes'
        '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:
                  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/recycle_bin/checklist/list_templates/%7Bid%7D',\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/recycle_bin/checklist/list_templates/%7Bid%7D", 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/recycle_bin/checklist/list_templates/%7Bid%7D \\\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/recycle_bin/checklist/list_templates/%7Bid%7D\"),\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
      x-changelog:
      - summary: Added Recycled Company Checklist (Inspection) Template show endpoint
        description: View a Recycled Checklist (Inspection) Template for a given company.
        endpoint: GET /companies/{company_id}/recycle_bin/checklist/list_templates/{id}
        type: new
        breaking: false
        datestamp: '2021-07-22'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: company-checklist-templates?version=1.0#show-recycled-company-checklist-template
      operationId: showRecycledCompanyChecklistTemplate
  /rest/v1.0/companies/{company_id}/recycle_bin/checklist/list_templates/{id}/restore:
    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: id
      in: path
      required: true
      description: Company Checklist Template ID
      schema:
        type: integer
    x-compliance-level: full
    patch:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: Restore a Recycled Company Checklist Template
      description: Restores the specified Recycled Company Checklist Template
      tags:
      - Company Checklist Template
      responses:
        '200':
          description: OK
        '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:
                  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
        '422':
          description: Unprocessable Entity
          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: 'PATCH',\n  url: 'https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/recycle_bin/checklist/list_templates/%7Bid%7D/restore',\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("PATCH", "/rest/v1.0/companies/%7Bcompany_id%7D/recycle_bin/checklist/list_templates/%7Bid%7D/restore", headers=headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        title: Curl
        content: "curl --request PATCH \\\n  --url https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/recycle_bin/checklist/list_templates/%7Bid%7D/restore \\\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.Patch,\n    RequestUri = new Uri(\"https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/recycle_bin/checklist/list_templates/%7Bid%7D/restore\"),\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
      x-changelog:
      - summary: Added Recycled Company Checklist (Inspection) Template restore endpoint
        description: Restore a Recycled Checklist (Inspection) Template for a given company.
        endpoint: PATCH /companies/{company_id}/recycle_bin/checklist/list_templates/{id}/restore
        type: new
        breaking: false
        datestamp: '2021-07-22'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: company-checklist-templates?version=1.0#restore-a-recycled-company-checklist-template
      operationId: restoreARecycledCompanyChecklistTemplate
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer