> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server.

# Get

GET https://pre-api.joincandidhealth.com/images/v1/{id}

Gets an image by imageId.

Reference: https://docs.joincandidhealth.com/api-reference/pre-encounter/images/v-1/get

## Authentication

- OAuth2 — send the obtained token as `Authorization: Bearer <token>`

## Servers

- `https://pre-api.joincandidhealth.com` (Production, default)
- `https://pre-api-staging.joincandidhealth.com` (Staging)
- `https://sandbox-pre-api.joincandidhealth.com` (CandidSandbox)
- `https://staging-pre-api.joincandidhealth.com` (CandidStaging)
- `http://localhost:4000` (Local)

## Request

### Path parameters

- `id` (string, required) — The unique identifier for an Image

## Response

### 200

- `deactivated` (boolean, required) — True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.
- `display_name` (string, required)
- `file_name` (string, required)
- `file_type` (string, required)
- `id` (string, required) — The unique identifier for an Image
- `organization_id` (string, required) — The organization that owns this object.
- `signed_url` (string, required) — A signed URL to the image. This url can be used to upload an image to GCP storage or to read the image contents.
- `status` (enum, required)
  - Allowed values: `PENDING`, `UPLOADED`, `FAILED`
- `updated_at` (datetime, required)
- `updating_user_id` (string, required) — The user ID of the user who last updated the object.
- `version` (integer, required) — The version of the object. Any update to any property of an object object will create a new version.
- `coverage` (CoverageAssociation, optional) — An association to a Coverage.
- `patient` (PatientAssociation, optional) — An association to a Patient.

## Errors

### 404 Not Found Error

- `errorName` ("NotFoundError", required)
- `content` (ErrorBase4xx, required)

## Types

### CoverageAssociation

An association to a Coverage.

- `id` (UUID, required) — The unique identifier for a Coverage in the database
- `side` (enum, required)
  - Allowed values: `FRONT`, `BACK`

### PatientAssociation

An association to a Patient.

- `id` (string, required) — The unique identifier for a Patient
- `notes` (string, optional)

### ErrorBase4xx

- `message` (string, required)
- `data` (any, optional)

## Examples

**Response**

```json
{
  "deactivated": true,
  "display_name": "display_name",
  "file_name": "file_name",
  "file_type": "file_type",
  "id": "id",
  "organization_id": "organization_id",
  "signed_url": "signed_url",
  "status": "PENDING",
  "updated_at": "2024-01-15T09:30:00Z",
  "updating_user_id": "updating_user_id",
  "version": 1,
  "coverage": {
    "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
    "side": "FRONT"
  },
  "patient": {
    "id": "id",
    "notes": "notes"
  }
}
```

**SDK Code**

```python
import requests

url = "https://pre-api.joincandidhealth.com/images/v1/id"

headers = {"Authorization": "<token>."}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://pre-api.joincandidhealth.com/images/v1/id';
const options = {method: 'GET', headers: {Authorization: '<token>.'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://pre-api.joincandidhealth.com/images/v1/id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<token>.")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://pre-api.joincandidhealth.com/images/v1/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<token>.'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://pre-api.joincandidhealth.com/images/v1/id")
  .header("Authorization", "<token>.")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://pre-api.joincandidhealth.com/images/v1/id', [
  'headers' => [
    'Authorization' => '<token>.',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://pre-api.joincandidhealth.com/images/v1/id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<token>.");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<token>."]

let request = NSMutableURLRequest(url: NSURL(string: "https://pre-api.joincandidhealth.com/images/v1/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```