Procore Recycle Bin Forms API

openapi: 3.2.0
info:
  title: Procore REST Recycle Bin Forms 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: Recycle Bin Forms
paths:
  /rest/v1.0/projects/{project_id}/recycle_bin/forms:
    parameters:
    - name: Procore-Company-Id
      in: header
      description: Unique company identifier associated with the Procore User Account.
      required: true
      schema:
        type: integer
    - name: project_id
      in: path
      required: true
      description: Unique identifier for the project.
      schema:
        type: integer
    x-compliance-level: full
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: List Recycled Project Forms
      description: Returns a collection of Recycled Forms for a specified Project.
      tags:
      - Recycle Bin Forms
      parameters:
      - name: page
        in: query
        description: Page
        schema:
          type: integer
      - name: per_page
        in: query
        description: Elements per page
        schema:
          type: integer
      - 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[created_at]
        in: query
        description: 'Return item(s) created 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: 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
      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 Project Forms
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: Unique identifier of the Form. Use as the `{id}` path parameter for show, update, delete, and send_email requests on this Form.
                      example: 999
                    created_at:
                      type: string
                      description: Timestamp when the Form was created, in ISO 8601 format.
                      format: date-time
                      example: '2016-08-23T15:23:57Z'
                    description:
                      type: string
                      description: Free-text description of the Form provided by its author.
                      example: This is a Form
                    form_template_id:
                      type: integer
                      description: ID of the Form Template this Form was created from. References a Form Template in the same company.
                      example: 1
                    form_template_name:
                      type: string
                      description: Name of the Form Template this Form was created from.
                      example: Inspection Form Template
                    name:
                      type: string
                      description: Display name of the Form.
                      example: Inspection Form
                    private:
                      type: boolean
                      description: When true, the Form is visible only to its creator and users with admin access to the Forms tool; when false, it is visible to all users who can view Forms.
                      example: false
                    created_by:
                      type: object
                      description: The user who created the Form.
                      properties:
                        id:
                          type: integer
                          description: ID of the user (login information) who created the Form.
                          example: 160586
                        login:
                          type: string
                          description: Email/login of the user who created the Form.
                          example: exampleuser@example.com
                        name:
                          type: string
                          description: Full name of the user who created the Form.
                          example: Carl Contractor
                    updated_at:
                      type: string
                      description: Timestamp when the Form was last updated, in ISO 8601 format.
                      format: date-time
                      example: '2016-08-23T15:23:57Z'
                    fillable_pdf:
                      type: object
                      description: The fillable PDF file backing this Form.
                      properties:
                        id:
                          type: integer
                          description: ID of the underlying file (Prostore File) for the fillable PDF.
                          example: 5324
                        url:
                          type: string
                          description: Download URL for the fillable PDF.
                          example: http://www.example.com/
                        filename:
                          type: string
                          description: Original filename of the fillable PDF.
                          example: january_receipt_copy.pdf
                        name:
                          type: string
                          description: Display name of the fillable PDF file.
                          example: january_receipt_copy.pdf
                        can_be_viewed:
                          type: boolean
                          description: True when the current user is permitted to view this file.
                          example: true
                        viewable:
                          type: boolean
                          description: True when a viewable (rendered) version of the PDF has been generated and can be displayed in-app.
                          example: true
                    attachments:
                      type: array
                      description: Additional files attached to the Form.
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            description: ID of the attached file (Prostore File).
                            example: 5324
                          url:
                            type: string
                            description: Download URL for the attachment.
                            example: http://www.example.com/
                          filename:
                            type: string
                            description: Original filename of the attachment.
                            example: january_receipt_copy.pdf
                          name:
                            type: string
                            description: Display name of the attachment.
                            example: january_receipt_copy.pdf
                          can_be_viewed:
                            type: boolean
                            description: True when the current user is permitted to view this attachment.
                            example: true
                          viewable:
                            type: boolean
                            description: True when a viewable (rendered) version of the attachment has been generated and can be displayed in-app.
                            example: true
                    thumbnail_url:
                      type: string
                      description: URL of the Form's thumbnail image. Falls back to a generic document placeholder image when no thumbnail has been generated.
                      example: https://storage.procore.com/files/thumbnail.png
                    viewable:
                      type: boolean
                      description: True when a viewable (rendered) version of the Form's fillable PDF exists and can be displayed in-app.
                      example: true
                    viewable_document_id:
                      type:
                      - integer
                      - 'null'
                      description: ID of the generated viewable document for the Form's fillable PDF. Null when no viewable version has been generated.
                      example: 4
                    holder_class:
                      type: string
                      description: Class name of the record that holds the file, used by attachment-related clients. Always "Form" for this resource.
                      example: Form
                    download_all_uuid:
                      type:
                      - object
                      - 'null'
                      description: Session token object used to request a bulk download of the Form and its attachments. Only populated on the show response; null otherwise.
                      additionalProperties: true
                    attachment:
                      type: object
                      description: The Form's primary fillable PDF, exposed as a single attachment object. Mirrors `fillable_pdf`.
                      properties:
                        id:
                          type: integer
                          description: ID of the attachment file (Prostore File).
                          example: 17
                        name:
                          type: string
                          description: Display name of the attachment.
                          example: test.pdf
                        url:
                          type: string
                          description: Download URL for the attachment.
                          example: https://storage.procore.com/files/attachment.png
                        filename:
                          type: string
                          description: Original filename of the attachment.
                          example: test.pdf
                        can_be_viewed:
                          type: boolean
                          description: True when the current user is permitted to view this attachment.
                          example: true
                        viewable:
                          type: boolean
                          description: True when a viewable (rendered) version of the attachment has been generated and can be displayed in-app.
                          example: true
                    permissions:
                      type: object
                      description: The current user's permissions for this Form. Only present when the request includes the `view=with_permissions` query parameter.
                      properties:
                        can_edit:
                          type: boolean
                          description: True when the current user can edit this Form.
                          example: false
                        can_view_change_history:
                          type: boolean
                          description: True when the current user can view this Form's change history.
                          example: true
                        can_view_download_log:
                          type: boolean
                          description: True when the current user can view this Form's download log.
                          example: true
                        can_email:
                          type: boolean
                          description: True when the current user can send this Form by email.
                          example: true
                        can_destroy:
                          type: boolean
                          description: True when the current user can delete this Form.
                          example: true
                    deleted:
                      type: boolean
                      description: True when the Form has been soft-deleted (moved to the recycle bin) and is pending permanent removal or restoration.
                      example: false
        '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 permission to view Forms
          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/projects/%7Bproject_id%7D/recycle_bin/forms',\n  qs: {\n    page: 'SOME_INTEGER_VALUE',\n    per_page: 'SOME_INTEGER_VALUE',\n    'filters[id]': 'SOME_ARRAY_VALUE',\n    'filters[created_at]': 'SOME_STRING_VALUE',\n    'filters[updated_at]': '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/projects/%7Bproject_id%7D/recycle_bin/forms?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bid%5D=SOME_ARRAY_VALUE&filters%5Bcreated_at%5D=SOME_STRING_VALUE&filters%5Bupdated_at%5D=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/projects/%7Bproject_id%7D/recycle_bin/forms?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bid%5D=SOME_ARRAY_VALUE&filters%5Bcreated_at%5D=SOME_STRING_VALUE&filters%5Bupdated_at%5D=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/projects/%7Bproject_id%7D/recycle_bin/forms?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&filters%5Bid%5D=SOME_ARRAY_VALUE&filters%5Bcreated_at%5D=SOME_STRING_VALUE&filters%5Bupdated_at%5D=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: listRecycledProjectForms
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer