Procore Schedule Resources API

openapi: 3.2.0
info:
  title: Procore REST Schedule Resources 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: Schedule Resources
paths:
  /rest/v1.0/companies/{company_id}/schedule/resources:
    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 Schedule Resources
      description: Returns all resources for a given company
      tags:
      - Schedule Resources
      parameters:
      - name: page
        in: query
        description: Page
        schema:
          type: integer
      - name: per_page
        in: query
        description: Elements per page
        schema:
          type: integer
      - name: filters[name]
        in: query
        description: Filter item(s) with matching name.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: Schedule Resources
                properties:
                  resources:
                    type: array
                    description: Resources
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Unique identifier for this schedule resource.
                          example: 2
                        name:
                          type:
                          - string
                          - 'null'
                          description: Display name of the schedule resource.
                          example: Electrician
                        source_uid:
                          type:
                          - string
                          - 'null'
                          description: Unique identifier from the external scheduling system.
                          example: b6e53ef0-20d8-11ee-be56-0242ac120002
        '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: User does not have right permissions
          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: Endpoint not found.
          content:
            application/json:
              schema:
                properties:
                  error:
                    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/schedule/resources',\n  qs: {\n    page: 'SOME_INTEGER_VALUE',\n    per_page: 'SOME_INTEGER_VALUE',\n    'filters[name]': 'SOME_ARRAY_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/schedule/resources?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bname%5D=SOME_ARRAY_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/schedule/resources?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bname%5D=SOME_ARRAY_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/schedule/resources?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bname%5D=SOME_ARRAY_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
      x-changelog:
      - summary: New 'List resources' API version
        description: Fetches all schedule resources for a given company.
        endpoint: GET /companies/{company_id}/schedule/resources
        type: new
        breaking: false
        datestamp: '2023-07-12'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: company-schedule-resources?version=1.0#list-schedule-resources
      operationId: listScheduleResources
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer