--- title: "Retrieve a document" url: "https://docs.unified.to/plm/document/Retrieve_a_document" description: "Retrieve a document with Unified's Document API (GET /plm/{connection_id}/document/{id}). Filter by fields and raw. Supported by 2 Document integrations." date: "2026-11-02T06:50:20.035Z" updated: "2026-11-02T06:50:20.035Z" --- # Retrieve a document Updated: November 2, 2026 GET/plm/{connection\_id}/document/{id} Retrieves a single PlmDocument by its `id`. Obtain `id` values from the corresponding list endpoint. Use `fields` to return only the fields you need. ## Parameters **fields**string array id created\_at updated\_at master\_identifier number name description revision status lifecycle\_state type original\_type category\_id part\_ids file\_ids user\_id url metadata raw Fields to return **raw**string Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar **connection\_id**string required ID of the connection **id**string required ID of the Document ## Returns [PlmDocument](https://docs.unified.to/plm/document/model.md) | Response field | Type | Required | Description | | ------------------------ | ------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | string | No | | | created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | master\_identifier | string | No | Vendor ID shared by every revision of the same document; not a unified object | | number | string | No | | | name | string | No | | | description | string | No | | | revision | string | No | | | status | enum | No | Normalized lifecycle status of a part or document revision Values: IN\_WORK, IN\_REVIEW, RELEASED, OBSOLETE, OTHER | | lifecycle\_state | string | No | | | type | enum | No | Normalized document type Values: DRAWING, CAD\_MODEL, SPECIFICATION, PROCEDURE, REPORT, OTHER | | original\_type | string | No | The vendor's own document type name | | category\_id | string | No | The PlmCategory the document is filed under (reference to AccountingCategory) | | part\_ids | string\[\] | No | Related PlmPart IDs | | file\_ids | string\[\] | No | Attachment IDs retrievable from StorageFile | | user\_id | string | No | (reference to HrisEmployee) | | url | string | No | | | metadata | PlmMetadata\[\] | No | | | metadata\[\].id | string | No | The ID of the custom field definition (from the metadata/metadata endpoint). | | metadata\[\].slug | string | No | The integration's API name (key) of an existing custom field. | | metadata\[\].value | object | No | The field's value, typed by format. | | metadata\[\].namespace | string | No | | | metadata\[\].format | enum | No | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL | | metadata\[\].extra\_data | object | No | | ## Errors Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). ```json { "statusCode": 429, "error": "Too Many Requests", "message": "Too many requests to unified.to API; max requests per minute: N" } ``` | Status | Error | Meaning | | ------ | --------------------- | ------------------------------------------------- | | 400 | Bad Request | The request was malformed or failed validation. | | 401 | Unauthorized | The connection is likely broken; re-authorize it. | | 403 | Forbidden | The connection is missing permissions or scopes. | | 404 | Not Found | The requested resource does not exist. | | 429 | Too Many Requests | Rate limit exceeded (see the two sources below). | | 500 | Internal Server Error | An unexpected error occurred. | | 501 | Not Implemented | Not supported by this integration. | Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. ### 429 Too Many Requests A 429 has two possible sources: * The integration's own rate limit, passed through. * Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`. ## Code Samples ### Node.js SDK ```javascript import { UnifiedTo } from '@unified-api/typescript-sdk'; const sdk = new UnifiedTo({ security: { jwt: '', }, }); const connectionId = '5de520f96e439b002043d8dc'; const id = '1234'; const results = await sdk.plm.getPlmDocument({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8', headers: { authorization: 'bearer .....' }, params: { fields: '', raw: '', } }; const results = await axios.request(options); ``` ### Java ```java AsyncHttpClient client = new DefaultAsyncHttpClient(); client.prepare("GET", "https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw=") .setHeader("accept", "application/json") .setHeader("authorization", ".....") .execute() .toCompletableFuture() .thenAccept(System.out::println) .join(); client.close(); ``` ### Go ```go import ( "fmt" "net/http" "io/ioutil" ) url := `https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw= req, _ := http.NewRequest("GET", url, nil) req.Header.Add("accept", "application/json") req.Header.Add("authorization", ".....") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := ioutil.ReadAll(res.Body) ``` ### Python ```python import requests url = "https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw=" headers = { "accept": "application/json", "authorization": "....." } response = requests.get(url, headers=headers) ``` ### PHP ```php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw=", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: ....." ], ]); ``` ### Ruby ```ruby require 'uri' require 'net/http' require 'openssl' url = URI("https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["authorization"] = '....' response = http.request(request) puts response.read_body ``` ### cURL ```bash curl --request GET \ --url 'https://api.unified.to/plm/5de520f96e439b002043d8dc/document/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```