Skip to main content
GET
/
mr
/
api
/
v1
/
docs
List Documents
curl --request GET \
  --url https://api.eka.care/mr/api/v1/docs \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Pt-Id: <x-pt-id>' \
  --header 'accept: <accept>'
{
  "items": [
    {
      "record": {
        "item": {
          "cases": [
            "<string>"
          ],
          "document_id": "df04c7e6-577b-4990-948c-5a31820c6a67",
          "upload_date": 1722929975,
          "document_type": "lr",
          "metadata": {
            "thumbnail": "https://vault-cdn.dev.eka.care/fac0704e-a0e3-4c93-a972-e6c1f188592d/df04c7e6-577b-4990-948c-5a31820c6a67/5dbc4b75-df1a-412d-82a3-77d54671398c.jpeg",
            "document_date": 1722929975,
            "tags": [
              "<string>"
            ],
            "auto_tags": [
              "TYPE_TAG_SMART"
            ],
            "title": "<string>",
            "abha": {
              "health_id": "mayank.singh@abdm",
              "link_status": "LINKED"
            }
          },
          "patient_id": 161494290947153
        }
      }
    }
  ],
  "next_token": "<string>",
  "source_refreshed_at": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
accept
enum<string>
required

To get response in json format

Available options:
application/json
​
X-Pt-Id
string
required

eka user id (OID)

Query Parameters

​
u_at__gt
integer<int64>

Filters the documents by returning all documents that were updated after the specified u_at__gt timestamp. The value should be a valid epoch timestamp.

Example:

1614556800

​
offset
string

Please include the nextPageToken from the API response to enable pagination.

​
p_oid
string

Include the patient identifier (p_oid) to fetch the list of records. Applicable only for EMR cases.

Response

A list of documents matching the query.

​
items
object[]
​
next_token
string

Token used for pagination to retrieve the next set of results in a paginated response.

​
source_refreshed_at
integer<int64> | null