Procore

Procore Capital Planning — Onboarding API

The Capital Planning — Onboarding API from Procore — 2 operation(s) for capital planning — onboarding.

GitHub OpenAPI

Operations 2

GET /rest/v1.0/companies/{company_id}/capital_planning/onboarding Get Capital Planning onboarding status #
POST /rest/v1.0/companies/{company_id}/capital_planning/onboarding/dismissal Dismiss the Capital Planning onboarding banner #

Documentation

📖
Documentation
https://developers.procore.com/documentation/introduction
📖
APIReference
https://developers.procore.com/reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/procore/refs/heads/main/openapi/procore-capital-planning-onboarding-api-openapi.yml

Other Resources

🔗
Portal
https://developers.procore.com
🔗
Signup
https://developers.procore.com/signup
🔗
Marketplace
https://marketplace.procore.com
🔗
ChangeLog
https://developers.procore.com/changelog
🔗
Support
https://developers.procore.com/support
🔗
StatusPage
https://status.procore.com
🔗
TermsOfService
https://www.procore.com/legal/terms-of-service
🔗
PrivacyPolicy
https://www.procore.com/legal/privacy

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/procore:procore-capital-planning-onboarding-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

procore-capital-planning-onboarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Procore REST Capital Planning — Onboarding 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: Capital Planning — Onboarding
paths:
  /rest/v1.0/companies/{company_id}/capital_planning/onboarding:
    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:
      description: Returns the company's onboarding status and the banner case the Capital Planning UI shows for it.
      operationId: OnboardingController_getOnboarding_rest/v1.0
      parameters:
      - name: company_id
        required: true
        in: path
        description: Procore company identifier
        schema:
          type: string
      responses:
        '200':
          description: Capital Planning onboarding status
          content:
            application/json:
              schema:
                type: object
                properties:
                  onboarding_status:
                    type: string
                    enum:
                    - pending
                    - ready
                    - failed
                    example: pending
                  banner_case:
                    type: number
                    enum:
                    - 1
                    - 2
                    - 3
                    example: 2
                    description: '1: ready with Capital Planning projects; 2: syncing or failed; 3: no active Procore projects'
                  banner_dismissed:
                    type: boolean
                    example: false
                    description: True when banner_case is 1 (the company has projects in Capital Planning) and the calling user has dismissed the banner
                required:
                - onboarding_status
                - banner_case
                - banner_dismissed
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          required:
                          - field
                          - message
                    required:
                    - code
                    - message
                    - details
                required:
                - error
        '403':
          description: Access denied — `TOOL_NOT_ACTIVATED`, `INSUFFICIENT_PERMISSIONS`, `READONLY_ACCESS`, or `ADMIN_ACCESS_REQUIRED`
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          required:
                          - field
                          - message
                    required:
                    - code
                    - message
                    - details
                required:
                - error
        '503':
          description: The permission check could not be completed (`AUTHORIZATION_UNAVAILABLE`) — safe to retry
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          required:
                          - field
                          - message
                    required:
                    - code
                    - message
                    - details
                required:
                - error
      summary: Get Capital Planning onboarding status
      tags:
      - Capital Planning — Onboarding
      x-doc:
        visibility: public
        stage: beta
        exposure: public
      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/capital_planning/onboarding',\n  headers: {'Procore-Company-Id': 'SOME_STRING_VALUE'}\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 = { ''Procore-Company-Id'': "SOME_STRING_VALUE" }


          conn.request("GET", "/rest/v1.0/companies/%7Bcompany_id%7D/capital_planning/onboarding", 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/capital_planning/onboarding \\\n  --header 'Procore-Company-Id: SOME_STRING_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/companies/%7Bcompany_id%7D/capital_planning/onboarding\"),\n    Headers =\n    {\n        { \"Procore-Company-Id\", \"SOME_STRING_VALUE\" },\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
  /rest/v1.0/companies/{company_id}/capital_planning/onboarding/dismissal:
    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
    post:
      description: Records that the calling user dismissed the onboarding banner. Only case 1 can be dismissed.
      operationId: OnboardingController_dismissBanner_rest/v1.0
      parameters:
      - name: company_id
        required: true
        in: path
        description: Procore company identifier
        schema:
          type: string
      responses:
        '204':
          description: Banner dismissal recorded
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          required:
                          - field
                          - message
                    required:
                    - code
                    - message
                    - details
                required:
                - error
        '403':
          description: Access denied — `TOOL_NOT_ACTIVATED`, `INSUFFICIENT_PERMISSIONS`, `READONLY_ACCESS`, or `ADMIN_ACCESS_REQUIRED`
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          required:
                          - field
                          - message
                    required:
                    - code
                    - message
                    - details
                required:
                - error
        '409':
          description: BANNER_NOT_DISMISSIBLE — the company is not in case 1
        '503':
          description: The permission check could not be completed (`AUTHORIZATION_UNAVAILABLE`) — safe to retry
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details:
                        type: array
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            message:
                              type: string
                          required:
                          - field
                          - message
                    required:
                    - code
                    - message
                    - details
                required:
                - error
      summary: Dismiss the Capital Planning onboarding banner
      tags:
      - Capital Planning — Onboarding
      x-doc:
        visibility: public
        stage: beta
        exposure: public
      x-code-samples:
      - id: node_request
        title: Node.js
        content: "const request = require('request');\n\nconst options = {\n  method: 'POST',\n  url: 'https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/capital_planning/onboarding/dismissal',\n  headers: {'Procore-Company-Id': 'SOME_STRING_VALUE'}\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 = { ''Procore-Company-Id'': "SOME_STRING_VALUE" }


          conn.request("POST", "/rest/v1.0/companies/%7Bcompany_id%7D/capital_planning/onboarding/dismissal", headers=headers)


          res = conn.getresponse()

          data = res.read()


          print(data.decode("utf-8"))'
      - id: shell_curl
        title: Curl
        content: "curl --request POST \\\n  --url https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/capital_planning/onboarding/dismissal \\\n  --header 'Procore-Company-Id: SOME_STRING_VALUE'"
      - id: csharp_httpclient
        title: C#
        content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n    Method = HttpMethod.Post,\n    RequestUri = new Uri(\"https://api.procore.com/rest/v1.0/companies/%7Bcompany_id%7D/capital_planning/onboarding/dismissal\"),\n    Headers =\n    {\n        { \"Procore-Company-Id\", \"SOME_STRING_VALUE\" },\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
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer