Procore Correspondence Types Defaults API

openapi: 3.2.0
info:
  title: Procore REST Correspondence Types Defaults 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: Correspondence Types Defaults
paths:
  /rest/v1.0/projects/{project_id}/correspondence_types/defaults:
    parameters:
    - name: Procore-Company-Id
      in: header
      description: Unique company identifier associated with the Procore User Account.
      required: true
      schema:
        type: integer
    x-compliance-level: partial
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: List Correspondence Type Defaults
      description: 'Returns a list of all Correspondence Types Defaults for the specificied Project.

        For more information on Generic Tool and Correspondence Tool endpoints,

        see Working with the Correspondence Tool.'
      tags:
      - Correspondence Types Defaults
      parameters:
      - name: project_id
        in: path
        required: true
        description: Unique identifier for the project.
        schema:
          type: integer
      - name: filters[generic_tool_id]
        in: query
        description: Return item(s) within the specified Generic Tool ID(s)
        required: false
        explode: false
        schema:
          type: array
          items:
            type: integer
      - name: page
        in: query
        description: Page
        schema:
          type: integer
      - name: per_page
        in: query
        description: Elements per page
        schema:
          type: integer
      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 Correspondence Type Defaults
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      example: 1
                    correspondence_type_id:
                      type: integer
                      example: 1
                    description:
                      type: string
                      example: A description
                    due_days:
                      type: integer
                      example: 1
                    distribution_members:
                      type: array
                      description: Distribution Members
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 161072
                          name:
                            type: string
                            example: Carl the Contractor
                    available_statuses:
                      type: array
                      items:
                        type: string
                        example: Open
                    statuses:
                      type: array
                      description: Statuses
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            example: In Progress
                          status:
                            type: string
                            example: Draft
                    private_by_default:
                      type: boolean
                      example: true
                    workflows_enabled:
                      type: boolean
                      example: false
                    has_workflow_instances:
                      type: boolean
                      description: Whether any item of this type already has a workflow, regardless of whether a workflow template is currently assigned. Unlike workflows_enabled, this does not indicate that a new workflow can be started.
                      example: false
                    workflow_has_missing_configuration:
                      type: boolean
                      example: false
                    workflow_preset_config_url:
                      type: string
                      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: 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
        default:
          description: Unexpected error
          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/correspondence_types/defaults',\n  qs: {\n    'filters[generic_tool_id]': 'SOME_ARRAY_VALUE',\n    page: 'SOME_INTEGER_VALUE',\n    per_page: 'SOME_INTEGER_VALUE'\n  }\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/projects/%7Bproject_id%7D/correspondence_types/defaults?filters%5Bgeneric_tool_id%5D=SOME_ARRAY_VALUE&page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE")


          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/correspondence_types/defaults?filters%5Bgeneric_tool_id%5D=SOME_ARRAY_VALUE&page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE'"
      - 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/correspondence_types/defaults?filters%5Bgeneric_tool_id%5D=SOME_ARRAY_VALUE&page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE\"),\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: Add is_successful to correspondence types defaults
        description: Statuses for correspondence types now include the is_successful property
        endpoint: GET /projects/{project_id}/correspondence_types/defaults
        type: feature
        breaking: false
        datestamp: '2024-01-24'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: correspondences?version=1.0#list-correspondence-type-defaults
      - summary: Add workflow_has_missing_configuration and workflow_preset_config_url to correspondence types defaults
        description: Response now includes if the default workflow has missing configuration and the url for the worfklow preset config page
        endpoint: GET /projects/{project_id}/correspondence_types/defaults
        type: feature
        breaking: false
        datestamp: '2024-11-07'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: correspondences?version=1.0#list-correspondence-type-defaults
      - summary: Move workflow_has_missing_configuration and workflow_preset_config_url to a new view
        description: New view workflows_configuration added to separate workflow_has_missing_configuration and workflow_preset_config_url from the defaul information
        endpoint: GET /projects/{project_id}/correspondence_types/defaults
        type: feature
        breaking: true
        datestamp: '2024-12-18'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: correspondences?version=1.0#list-correspondence-type-defaults
      - summary: Add has_workflow_instances to correspondence types defaults
        description: The response now includes has_workflow_instances, which is true when any item of the type already has a workflow. Unlike workflows_enabled, it stays true after every workflow template is unassigned, so clients can keep showing existing workflow data without implying a new workflow can be started.
        endpoint: GET /projects/{project_id}/correspondence_types/defaults
        type: feature
        breaking: false
        datestamp: '2026-08-10'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: correspondences?version=1.0#list-correspondence-type-defaults
      operationId: listCorrespondenceTypeDefaults
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer