GET
/
abdm
/
v1
/
request
curl --request GET \
  --url https://api.eka.care/abdm/v1/request \
  --header 'Authorization: Bearer <token>'
{
  "access_mode": "view",
  "created_at": "2023-11-07T05:31:56Z",
  "duration": {
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z"
  },
  "erase_at": "2023-11-07T05:31:56Z",
  "hi_types": [
    {
      "display": "<string>",
      "enabled": true,
      "id": "OPConsultation"
    }
  ],
  "hiu": {
    "id": "INXXXXX",
    "name": "Apollo Hospital"
  },
  "id": "<string>",
  "providers": [
    {
      "care_contexts": [
        {
          "display": "<string>",
          "id": "<string>"
        }
      ],
      "consent_artefact_id": null,
      "hip": {
        "id": "INXXXXX",
        "name": "Apollo Hospital"
      }
    }
  ],
  "purpose": {
    "code": "<string>",
    "text": "<string>"
  },
  "requester": {
    "name": "Dr John"
  },
  "status": "requested",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

The API requires a Bearer token (JWT) for authentication.

Query Parameters

​
id
string
required

Consent/Subscription/Authorization ID

​
type
enum<string>

Request type

Available options:
consent,
subscription,
authorization
​
status
enum<string>

Status of the request

Available options:
requested,
granted,
expired,
denied,
revoked

Response

200
application/json
OK
​
access_mode
enum<string>
Available options:
view
​
created_at
string
​
duration
object
​
erase_at
string
​
hi_types
object[] | null

List of HI Types

​
hiu
object

HIU details

​
id
string
​
providers
object[] | null

List of Providers/Failities details

​
purpose
object

Purpose of the request

​
requester
object

Requester details

​
status
enum<string>
Available options:
requested,
granted,
expired,
denied,
revoked
​
updated_at
string
List requestsOverview