Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Procore REST Pages Edit V 2 Controller 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: pages-edit-v-2-controller
paths:
/rest/v2.0/companies/{company_id}/projects/{project_id}/file_processors/{item_type}/{item_id}/pages/edit:
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:
tags:
- pages-edit-v-2-controller
summary: Apply a batch of in-place page operations to a document (project scope, v2)
description: Mutates the served LINEARIZED PDF (delete/insert/reorder/rotate), uploads a standalone candidate, activates it as the working LINEARIZED (pruning the prior copy), and remaps markups via MMS apply_page_map. PDM is not supported until FAS can stage a LINEARIZED candidate without deleting the currently served file. Response uses the v2 data envelope.
operationId: editPages
parameters:
- name: company_id
in: path
description: Unique identifier of the company
required: true
schema:
type: string
- name: project_id
in: path
description: Unique identifier of the project
required: true
schema:
type: string
- name: item_type
in: path
description: Item type discriminator (e.g. FileVersion, drawing_revision)
required: true
schema:
type: string
- name: item_id
in: path
description: Unique identifier of the item to edit
required: true
schema:
type: string
- name: attachment_id
in: query
description: Optional Prostore attachment identifier
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
operation_id:
type: string
expected_version:
type: integer
format: int32
originator_client_id:
type: string
operations:
type: array
items:
type: object
properties:
type:
type: string
enum:
- DELETE
- INSERT
- REORDER
- ROTATE
pages:
type: array
items:
type: integer
format: int32
insert_at:
type: integer
format: int32
count:
type: integer
format: int32
maximum: 100
minimum: 1
page_kind:
type: string
enum:
- BLANK
- TEMPLATE
page_size:
type: string
template_id:
type: string
moves:
type: array
items:
type: object
properties:
pages:
type: array
items:
type: integer
format: int32
minItems: 1
before:
type: integer
format: int32
minimum: 1
required:
- before
- pages
order:
type: array
deprecated: true
items:
type: integer
format: int32
deprecated: true
rotation:
type: integer
format: int32
required:
- type
maxItems: 20
minItems: 0
required:
- expected_version
- operations
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
properties:
data:
type: object
properties:
operation_id:
type: string
linearized_fas_id:
type: string
total_page_count:
type: integer
format: int32
already_applied:
type: boolean
markups_shifted:
type: integer
format: int32
markups_orphaned:
type: integer
format: int32
pins_shifted:
type: integer
format: int32
pins_orphaned:
type: integer
format: int32
version:
type: integer
format: int32
status:
type: string
x-rate-limit-enabled: true
x-doc:
visibility: public
stage: ga
exposure: public
x-code-samples:
- id: node_request
mimeType: application/json
title: Node.js
content: "const request = require('request');\n\nconst options = {\n method: 'POST',\n url: 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit',\n qs: {attachment_id: 'SOME_STRING_VALUE'},\n headers: {'content-type': 'application/json'},\n body: {\n operation_id: 'string',\n expected_version: 0,\n originator_client_id: 'string',\n operations: [\n {\n type: 'DELETE',\n pages: [0],\n insert_at: 0,\n count: 1,\n page_kind: 'BLANK',\n page_size: 'string',\n template_id: 'string',\n moves: [{pages: [0], before: 1}],\n order: [0],\n rotation: 0\n }\n ]\n },\n json: true\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
mimeType: application/json
title: Python3
content: 'import http.client
conn = http.client.HTTPConnection("localhost:8080")
payload = "{\"operation_id\":\"string\",\"expected_version\":0,\"originator_client_id\":\"string\",\"operations\":[{\"type\":\"DELETE\",\"pages\":[0],\"insert_at\":0,\"count\":1,\"page_kind\":\"BLANK\",\"page_size\":\"string\",\"template_id\":\"string\",\"moves\":[{\"pages\":[0],\"before\":1}],\"order\":[0],\"rotation\":0}]}"
headers = { ''content-type'': "application/json" }
conn.request("POST", "/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit?attachment_id=SOME_STRING_VALUE", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))'
- id: shell_curl
mimeType: application/json
title: Curl
content: "curl --request POST \\\n --url 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit?attachment_id=SOME_STRING_VALUE' \\\n --header 'content-type: application/json' \\\n --data '{\"operation_id\":\"string\",\"expected_version\":0,\"originator_client_id\":\"string\",\"operations\":[{\"type\":\"DELETE\",\"pages\":[0],\"insert_at\":0,\"count\":1,\"page_kind\":\"BLANK\",\"page_size\":\"string\",\"template_id\":\"string\",\"moves\":[{\"pages\":[0],\"before\":1}],\"order\":[0],\"rotation\":0}]}'"
- id: csharp_httpclient
mimeType: application/json
title: C#
content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Post,\n RequestUri = new Uri(\"http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit?attachment_id=SOME_STRING_VALUE\"),\n Content = new StringContent(\"{\\\"operation_id\\\":\\\"string\\\",\\\"expected_version\\\":0,\\\"originator_client_id\\\":\\\"string\\\",\\\"operations\\\":[{\\\"type\\\":\\\"DELETE\\\",\\\"pages\\\":[0],\\\"insert_at\\\":0,\\\"count\\\":1,\\\"page_kind\\\":\\\"BLANK\\\",\\\"page_size\\\":\\\"string\\\",\\\"template_id\\\":\\\"string\\\",\\\"moves\\\":[{\\\"pages\\\":[0],\\\"before\\\":1}],\\\"order\\\":[0],\\\"rotation\\\":0}]}\")\n {\n Headers =\n {\n ContentType = new MediaTypeHeaderValue(\"application/json\")\n }\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}"
? /rest/v2.0/companies/{company_id}/projects/{project_id}/file_processors/{item_type}/{item_id}/pages/edit/status/{operation_id}
: 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:
tags:
- pages-edit-v-2-controller
summary: Poll the status of an asynchronous pages/edit operation
description: Returns the D8 intent-backed status of a pages/edit operation. Used after HTTP 202.
operationId: editStatus
parameters:
- name: company_id
in: path
description: Unique identifier of the company
required: true
schema:
type: string
- name: project_id
in: path
description: Unique identifier of the project
required: true
schema:
type: string
- name: item_type
in: path
description: Item type discriminator (e.g. FileVersion, drawing_revision)
required: true
schema:
type: string
- name: item_id
in: path
description: Unique identifier of the item being edited
required: true
schema:
type: string
- name: operation_id
in: path
description: Idempotent operation identifier returned by POST pages/edit
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
properties:
data:
type: object
properties:
operation_id:
type: string
linearized_fas_id:
type: string
total_page_count:
type: integer
format: int32
already_applied:
type: boolean
markups_shifted:
type: integer
format: int32
markups_orphaned:
type: integer
format: int32
pins_shifted:
type: integer
format: int32
pins_orphaned:
type: integer
format: int32
version:
type: integer
format: int32
status:
type: string
x-rate-limit-enabled: true
x-doc:
visibility: public
stage: ga
exposure: public
x-code-samples:
- id: node_request
title: Node.js
content: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit/status/%7Boperation_id%7D'\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.HTTPConnection("localhost:8080")
conn.request("GET", "/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit/status/%7Boperation_id%7D")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))'
- id: shell_curl
title: Curl
content: "curl --request GET \\\n --url http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit/status/%7Boperation_id%7D"
- id: csharp_httpclient
title: C#
content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit/status/%7Boperation_id%7D\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}"
/rest/v2.0/companies/{company_id}/projects/{project_id}/file_processors/{item_type}/{item_id}/pages/edit/version:
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:
tags:
- pages-edit-v-2-controller
summary: Return the current document_edit_version for version-gated reads
description: Exposes FP's per-document version authority so clients can detect commit-window skew versus MMS current_version.
operationId: editVersion
parameters:
- name: company_id
in: path
description: Unique identifier of the company
required: true
schema:
type: string
- name: project_id
in: path
description: Unique identifier of the project
required: true
schema:
type: string
- name: item_type
in: path
description: Item type discriminator (e.g. FileVersion, drawing_revision)
required: true
schema:
type: string
- name: item_id
in: path
description: Unique identifier of the item
required: true
schema:
type: string
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
properties:
data:
type: object
properties:
item_id:
type: string
item_type:
type: string
version:
type: integer
format: int32
x-rate-limit-enabled: true
x-doc:
visibility: public
stage: ga
exposure: public
x-code-samples:
- id: node_request
title: Node.js
content: "const request = require('request');\n\nconst options = {\n method: 'GET',\n url: 'http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit/version'\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.HTTPConnection("localhost:8080")
conn.request("GET", "/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))'
- id: shell_curl
title: Curl
content: "curl --request GET \\\n --url http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit/version"
- id: csharp_httpclient
title: C#
content: "var client = new HttpClient();\nvar request = new HttpRequestMessage\n{\n Method = HttpMethod.Get,\n RequestUri = new Uri(\"http://localhost:8080/rest/v2.0/companies/%7Bcompany_id%7D/projects/%7Bproject_id%7D/file_processors/%7Bitem_type%7D/%7Bitem_id%7D/pages/edit/version\"),\n};\nusing (var response = await client.SendAsync(request))\n{\n response.EnsureSuccessStatusCode();\n var body = await response.Content.ReadAsStringAsync();\n Console.WriteLine(body);\n}"
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer