Skip to main content
GET
/
assess
/
fetch_assessments
/
Fetch assessments (Deprecated)
curl --request GET \
  --url https://api.eka.care/assess/fetch_assessments/ \
  --header 'auth: <api-key>'
{
  "conversations": {
    "12345": [
      {
        "conversationid": "sa_123456",
        "created_at": "2023-06-15T12:34:56Z",
        "created_epoch": 1686820496,
        "wfid": 1,
        "share_to_abha": true
      },
      {
        "conversationid": "sa_123457",
        "created_at": "2023-06-16T12:34:56Z",
        "created_epoch": 1686906896,
        "wfid": 2,
        "share_to_abha": false
      }
    ],
    "67890": [
      {
        "conversationid": "sn_987654",
        "created_at": "2023-06-17T12:34:56Z",
        "created_epoch": 1686993296,
        "wfid": 3,
        "share_to_abha": true
      }
    ]
  }
}

​
Fetch Assessments by ID

This API allows you to fetch assessments for patients or doctors based on various filters such as status, workflow IDs, and date range.

​
Example Request

curl --location 'https://api.eka.care/assess/fetch_assessments/?status=COMPLETED&pids=174592378117946,174592378117944' \
--header 'Content-Type: application/json' \
--header 'HTTP_CLIENT_ID: eka' \
--header 'Authorization: Bearer <your-auth-token>'

Authorizations

​
auth
string
header
required

Query Parameters

​
pids
string

Comma-separated list of patient IDs.

Example:

"12345,67890"

​
puuid
string

Patient UUID.

Example:

"430915f2-c802-4442-be8d-8c725fb83555"

​
docid
string

Doctor ID.

Example:

"174359082080545"

​
status
enum<string>
default:COMPLETED

Status of the assessment.

Available options:
COMPLETED,
IN_REVIEW
​
sd
string<date>

Start date for filtering assessments (YYYY-MM-DD).

Example:

"2023-01-01"

​
ed
string<date>

End date for filtering assessments (YYYY-MM-DD).

Example:

"2023-12-31"

​
wflowid
string

Comma-separated list of workflow IDs.

Example:

"1,2,3"

​
is_abha_linkable
boolean

Filter assessments that are ABHA linkable.

Example:

true

​
limit
integer
default:30

Number of results to return per page.

​
offset
integer
default:0

Offset for pagination.

​
sort
enum<string>
default:asc

Sort order for results.

Available options:
asc,
desc

Response

Successful response with assessment data.

​
conversations
object
Example:
{
  "12345": [
    {
      "conversationid": "sa_123456",
      "created_at": "2023-06-15T12:34:56Z",
      "created_epoch": 1686820496,
      "wfid": 1,
      "share_to_abha": true
    },
    {
      "conversationid": "sa_123457",
      "created_at": "2023-06-16T12:34:56Z",
      "created_epoch": 1686906896,
      "wfid": 2,
      "share_to_abha": false
    }
  ],
  "67890": [
    {
      "conversationid": "sn_987654",
      "created_at": "2023-06-17T12:34:56Z",
      "created_epoch": 1686993296,
      "wfid": 3,
      "share_to_abha": true
    }
  ]
}
⌘I