Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,8 @@
# url: /document-management-api-endpoints - Retired 2026-08-17, re-hosted endpoint data; see the REST reference. Needed for Redirect
- title: Technical Guide
url: /document-management-technical-guide
# - title: Document Revisions
# url: /document-management-document-revisions - Hidden until DOCINT-1853 flips List Document Revisions to public visibility
- title: Document Revisions
url: /document-management-document-revisions
- title: Metadata Details
url: /document-management-metadata-details

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ This guide covers the read side of that lifecycle: how to list revisions after s

***

> **List Document Revisions and List Recycled Document Revisions are private and beta.** Both are annotated `visibility: private` and `stage: beta` in the Document Management service. List Selected Document Revisions is public and beta.
> **These endpoints are in beta.** Watch the changelog for new [resource versions]({{ site.url }}{{ site.baseurl }}{% link getting_started/rest_api_overview.md %}).
{: .callout .callout--warning}

All three endpoints require a valid OAuth 2.0 token. Results are scoped to the calling principal's Document Management permission groups — the same request returns different rows for different tokens. How a withheld revision appears depends on the call: a discovery list omits it with no withheld-count signal; a hydration call by ID returns a masked row. See [Permission Scoping](#permission-scoping).
All endpoints require a valid OAuth 2.0 token. Results are scoped to the calling principal's Document Management permission groups — the same request returns different rows for different tokens. How a withheld revision appears depends on the call: a discovery list omits it with no withheld-count signal; a hydration call by ID returns a masked row. See [Permission Scoping](#permission-scoping).

### Base URL

Expand All @@ -36,7 +36,7 @@ Document Revision read endpoints use the following base path:
/rest/v{version}/companies/{company_id}/projects/{project_id}/document_management
```

Replace `{version}` with the version shown on each endpoint (`2.0` or `2.1`). Replace `{company_id}` and `{project_id}` with your actual Procore company and project IDs. List Document Revisions and List Selected Document Revisions are mounted on both `2.0` and `2.1`. List Recycled Document Revisions is mounted on `2.0` only.
Replace `{version}` with the version shown on each endpoint (`2.0` or `2.1`). Replace `{company_id}` and `{project_id}` with your actual Procore company and project IDs. List Document Revisions, List Selected Document Revisions, and Download Document Revision are mounted on both `2.0` and `2.1`. List Recycled Document Revisions and Download Recycled Document Revision are mounted on `2.0` only.

### Three Endpoints, Three Jobs

Expand Down Expand Up @@ -321,12 +321,22 @@ How a withheld revision appears depends on the call:

## Downloading a Revision

Full-record list, selected-revisions, and recycled-revisions responses include `download_url` when the caller has view access:
Full-record list, selected-revisions, and recycled-revisions responses include `download_url` when the caller has view access.

**Request** — [Download Document Revision](https://developers.procore.com/reference/rest/document-revisions?version=2.0#download-document-revision)

```
GET /rest/v2.0/companies/{company_id}/projects/{project_id}/document_management/document_revisions/{document_revision_id}/download
```

**Request** — [Download Recycled Document Revision](https://developers.procore.com/reference/rest/document-revisions?version=2.0#download-recycled-document-revision)

```
https://{host}/rest/v2.0/companies/{company_id}/projects/{project_id}/document_management/document_revisions/{document_revision_id}/download
GET /rest/v2.0/companies/{company_id}/projects/{project_id}/document_management/document_revisions/recycled_revisions/{document_revision_id}/download
```

This endpoint is `2.0` only. It requires Recycle Bin view permission (`view_recycle_bin`).

GET that URL with the same OAuth 2.0 token. The service responds with HTTP 302 to a short-lived storage URL. Follow the redirect to retrieve the file bytes. Pass `no_redirect=true` to receive HTTP 200 with a JSON body instead of the 302.

`download_url` is never present on a `view=ids_only` response — hydrate first, then download. Masked hydration rows also omit it.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Before you begin working with the various Document Management API endpoints, we

- **Overview** (this page)
- [Technical Guide]({{ site.url }}{{ site.baseurl }}{% link document_management_integration/document_management_technical_guide.md %})
- [Working with Document Revisions]({{ site.url }}{{ site.baseurl }}{% link document_management_integration/document_management_document_revisions.md %})
- [Metadata Details]({{ site.url }}{{ site.baseurl }}{% link document_management_integration/document_management_metadata_details.md %})
- [API Reference: Document Management](https://developers.procore.com/reference/rest/document-uploads?version=2.0) — canonical endpoint list, maintained per API version

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ This reference describes the metadata structure returned by **Document Upload**

- [Overview]({{ site.url }}{{ site.baseurl }}{% link document_management_integration/document_management_intro.md %})
- [Technical Guide]({{ site.url }}{{ site.baseurl }}{% link document_management_integration/document_management_technical_guide.md %})
- [Working with Document Revisions]({{ site.url }}{{ site.baseurl }}{% link document_management_integration/document_management_document_revisions.md %})
- **Metadata Details** (this page)
- [API Reference: Document Management](https://developers.procore.com/reference/rest/document-uploads?version=2.0) — canonical endpoint list, maintained per API version

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This guide walks you through the complete API workflow for uploading documents,

- [Overview]({{ site.url }}{{ site.baseurl }}{% link document_management_integration/document_management_intro.md %})
- **Technical Guide** (this page)
- [Working with Document Revisions]({{ site.url }}{{ site.baseurl }}{% link document_management_integration/document_management_document_revisions.md %})
- [Metadata Details]({{ site.url }}{{ site.baseurl }}{% link document_management_integration/document_management_metadata_details.md %})
- [API Reference: Document Management](https://developers.procore.com/reference/rest/document-uploads?version=2.0) — canonical endpoint list, maintained per API version

Expand Down