Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
Contact Sales
LogoLogo
API ReferencePre EncounterImagesV1

Get Multi

Beta
GET
/images/v1
GET
/images/v1
1curl https://pre-api.joincandidhealth.com/images/v1 \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1[
2  {
3    "deactivated": true,
4    "display_name": "display_name",
5    "file_name": "file_name",
6    "file_type": "file_type",
7    "id": "id",
8    "organization_id": "organization_id",
9    "signed_url": "signed_url",
10    "status": "PENDING",
11    "updated_at": "2024-01-15T09:30:00Z",
12    "updating_user_id": "updating_user_id",
13    "version": 1,
14    "coverage": {
15      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16      "side": "FRONT"
17    },
18    "patient": {
19      "id": "id",
20      "notes": "notes"
21    }
22  },
23  {
24    "deactivated": true,
25    "display_name": "display_name",
26    "file_name": "file_name",
27    "file_type": "file_type",
28    "id": "id",
29    "organization_id": "organization_id",
30    "signed_url": "signed_url",
31    "status": "PENDING",
32    "updated_at": "2024-01-15T09:30:00Z",
33    "updating_user_id": "updating_user_id",
34    "version": 1,
35    "coverage": {
36      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
37      "side": "FRONT"
38    },
39    "patient": {
40      "id": "id",
41      "notes": "notes"
42    }
43  }
44]
Searches for images that match the query parameters.
Was this page helpful?
Previous

Get Patient List

Next
Built with
Get Patient List
Searches for images that match the query parameters.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

patient_idstringOptional
coverage_idstringOptional

Response

This endpoint returns a list of objects.
deactivatedboolean
True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.
display_namestring
file_namestring
file_typestring
idstring
The unique identifier for an Image
organization_idstring
The organization that owns this object.
signed_urlstring
A signed URL to the image. This url can be used to upload an image to GCP storage or to read the image contents.
statusenum
Allowed values:
updated_atdatetime
updating_user_idstring
The user ID of the user who last updated the object.
versioninteger
The version of the object. Any update to any property of an object object will create a new version.
coverageobject or null
An association to a Coverage.
patientobject or null
An association to a Patient.