Skip to main content
GET
/
user
/
patient
/
{patient_id}
/
credit
Get Patient Credits
curl --request GET \
  --url https://api.decodahealth.com/user/patient/{patient_id}/credit \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "data": [
    {
      "id": "<string>",
      "patientId": "<string>",
      "amount": 123,
      "amountRemaining": 123,
      "createdDate": "2023-11-07T05:31:56Z",
      "comment": "<string>",
      "expiryDate": "2023-11-07T05:31:56Z",
      "memberId": "<string>",
      "updatedDate": "2023-11-07T05:31:56Z",
      "creator": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>"
      }
    }
  ],
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.decodahealth.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Path Parameters

​
patient_id
string
required

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:50
Required range: 1 <= x <= 100
​
include_expired
boolean
default:false

Include expired credits in results

​
include_used
boolean
default:true

Include fully used credits in results

Response

Successful Response

​
data
PatientCreditSummary · object[]
required
​
total
integer
required