Procore Companies API

openapi: 3.2.0
info:
  title: Procore REST Companies 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: Companies
paths:
  /rest/v1.0/companies:
    x-compliance-level: full
    get:
      x-doc:
        visibility: public
        stage: ga
        exposure: public
      summary: List Companies
      description: 'Returns companies visible to the current user.


        NOTE: This endpoint does not require the [''Procore-Company-Id'' header]

        (https://developers.procore.com/documentation/tutorial-mpz)

        to be included on a request.'
      tags:
      - Companies
      parameters:
      - name: page
        in: query
        description: Page
        schema:
          type: integer
      - name: per_page
        in: query
        description: Elements per page
        schema:
          type: integer
      - name: include_free_companies
        in: query
        description: When true, includes free companies that are otherwise excluded by default.
        schema:
          type: boolean
      - name: all
        in: query
        description: When the value is the string `true`, returns all companies available to the user, including other zones and owners companies. Ignores `view` and returns the `with_owners_and_timed_out` shape.
        schema:
          type: boolean
      - name: view
        in: query
        description: Response view for the company list. Defaults to `compact`. The 200 schema documents that default. Other values change which fields are returned.
        schema:
          type: string
          enum:
          - compact
          - with_root
          - with_owners
          - with_owners_and_timed_out
          - all_zones_with_is_demo
          - pcn
          - erp
          - my_company
          - show
          - with_locale_and_segment
          - enable_docusign_integration
          - legacy_internal_super_user_view
      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:
                title: arrayOfCompanies
                type: array
                items:
                  type: object
                  title: Company
                  description: Company visible to the current user.
                  properties:
                    id:
                      type: integer
                      description: Unique identifier for the company.
                      example: 1
                    name:
                      type: string
                      description: Display name of the company.
                      example: ABC Drywall
                    is_active:
                      type: boolean
                      description: Whether the company is active.
                      example: true
                    logo_url:
                      type: string
                      description: URL of the company logo.
                      example: https://pro-core.com/prostore/logo.gif
                    pcn_business_experience:
                      type:
                      - boolean
                      - 'null'
                      description: Whether Procore Construction Network business experience is enabled for the company.
                      example: true
                    my_company:
                      type:
                      - boolean
                      - 'null'
                      description: Whether the current user is an active employee of this company. True for at most one company in a list response.
                      example: true
        '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/companies',\n  qs: {\n    page: 'SOME_INTEGER_VALUE',\n    per_page: 'SOME_INTEGER_VALUE',\n    include_free_companies: 'SOME_BOOLEAN_VALUE',\n    all: 'SOME_BOOLEAN_VALUE',\n    view: '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/companies?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&include_free_companies=SOME_BOOLEAN_VALUE&all=SOME_BOOLEAN_VALUE&view=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/companies?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&include_free_companies=SOME_BOOLEAN_VALUE&all=SOME_BOOLEAN_VALUE&view=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/companies?page=SOME_INTEGER_VALUE&per_page=SOME_INTEGER_VALUE&include_free_companies=SOME_BOOLEAN_VALUE&all=SOME_BOOLEAN_VALUE&view=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
      x-changelog:
      - summary: Added Company Logo to index endpoint
        description: Companies index now includes Logo URLs
        endpoint: GET /companies
        type: feature
        breaking: false
        datestamp: '2023-02-28'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: companies?version=1.0#list-companies
      - summary: Added "My Company"
        description: Companies index now includes "My Company" field to identify the users primary company
        endpoint: GET /companies
        type: feature
        breaking: false
        datestamp: '2023-05-09'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: companies?version=1.0#list-companies
      - summary: Using WEB_ROOT for internal hosts
        description: If view is :with_root and host is '.internal' then WEB_ROOT is used instead of root_url
        endpoint: GET /companies
        type: feature
        breaking: false
        datestamp: '2024-12-03'
        versions:
        - '1.0'
        - '2.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: companies?version=1.0#list-companies
      - summary: Added has_permissions_tool to the with_root view
        description: 'Requests to List Companies with `view=with_root` now include `has_permissions_tool`.

          It indicates whether the company has the Permissions tool active and available, which

          distinguishes a company that has been upgraded from free to paid from one that is still

          free — both keep `pcn_business_experience` set. The default view is unchanged.'
        endpoint: GET /companies
        type: feature
        breaking: false
        datestamp: '2026-09-30'
        versions:
        - '1.0'
        x-doc:
          visibility: public
          stage: ga
          exposure: public
        link: companies?version=1.0#list-companies
      operationId: listCompanies
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer