--- title: "Retrieve a matter" url: "https://docs.unified.to/legal/matter/Retrieve_a_matter" description: "Retrieve a matter with Unified's Matter API (GET /legal/{connection_id}/matter/{id}). Filter by fields and raw. Supported by 13 Matter integrations." --- # Retrieve a matter GET/legal/{connection\_id}/matter/{id} ## Parameters **fields**string array id created\_at updated\_at name number description status billing\_method practicearea\_id stage contact\_ids company\_ids parties user\_id originating\_user\_id user\_ids client\_reference currency is\_billable opened\_at closed\_at pending\_at statute\_of\_limitations\_at 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 Matter ## Returns [LegalMatter](https://docs.unified.to/legal/matter/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) | | name | string | No | | | number | string | No | the firm's display/matter number | | description | string | No | | | status | enum | No | Values: PENDING, OPEN, CLOSED, OTHER | | billing\_method | enum | No | Values: HOURLY, FLAT\_FEE, CONTINGENCY, OTHER | | practicearea\_id | string | No | pointer to the Legal Practicearea object | | stage | string | No | the matter stage name | | contact\_ids | string\[\] | No | CRM Contacts that are clients on this matter | | company\_ids | string\[\] | No | CRM Companies that are clients on this matter | | parties | [LegalParty](https://docs.unified.to/legal/matter/Retrieve%5Fa%5Fmatter.md#LegalParty)\[\] | No | all people and organizations related to this matter, with their role | | parties\[\].contact\_id | string | No | pointer to a CRM Contact | | parties\[\].company\_id | string | No | pointer to a CRM Company | | parties\[\].role | enum | No | Values: CLIENT, OPPOSING\_PARTY, OPPOSING\_COUNSEL, CO\_COUNSEL, WITNESS, EXPERT, JUDGE, REFERRER, OTHER | | parties\[\].description | string | No | the vendor's free-text relationship description | | user\_id | string | No | HR Employee who is the responsible attorney (reference to HrisEmployee) | | originating\_user\_id | string | No | HR Employee who is the originating attorney (reference to HrisEmployee) | | user\_ids | string\[\] | No | other HR Employees assigned to this matter | | client\_reference | string | No | the client's own reference number for this matter | | currency | string | No | | | is\_billable | boolean | No | | | opened\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | closed\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | pending\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | statute\_of\_limitations\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | metadata | [LegalMetadata](https://docs.unified.to/legal/matter/Retrieve%5Fa%5Fmatter.md#LegalMetadata)\[\] | No | custom field values | | metadata\[\].id | string | No | | | metadata\[\].slug | string | No | | | metadata\[\].value | object | No | | | metadata\[\].namespace | string | No | | | metadata\[\].format | enum | No | 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.legal.getLegalMatter({ connectionId, id, fields: '', raw: '', }); ``` ### Node.js (axios) ```javascript const options = { method: 'GET', url: 'https://api.unified.to/legal/5de520f96e439b002043d8dc/matter/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/legal/5de520f96e439b002043d8dc/matter/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/legal/5de520f96e439b002043d8dc/matter/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/legal/5de520f96e439b002043d8dc/matter/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/legal/5de520f96e439b002043d8dc/matter/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/legal/5de520f96e439b002043d8dc/matter/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/legal/5de520f96e439b002043d8dc/matter/5de520f96e439b002043d8d8?fields=&raw=' \ --header 'accept: application/json' \ --header 'authorization: .....' ```