v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

List Documents

To get the list of all the records for a given authenticated user.

get/mr/api/v1/docs

Query parameters

u_at__gtinteger

Example:1614556800

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.

offsetstring

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

Headers

accept'application/json' required

To get response in json format

X-Pt-Idstring required

eka user id (OID)

Response

A list of documents matching the query.

next_tokenstring

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

source_refreshed_atinteger nullable

Example response

{
  "items": [
    {
      "record": {
        "item": {
          "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,
            "auto_tags": [
              "TYPE_TAG_SMART"
            ],
            "abha": {
              "health_id": "mayank.singh@abdm"
            }
          }
        }
      }
    }
  ]
}