PAparticlehealth
Subscriptions

List Patient Subscriptions ( optional by given type )

Changed on
get/api/v2/patients/{particle_patient_id}/subscriptions

Request

  • Base URL
    https://sandbox.particlehealth.com
  • URL
    https://sandbox.particlehealth.com/api/v2/patients/{particle_patient_id}/subscriptions
  • Auth
    API key in header Authorization

Path parameters

particle_patient_idstring required

Particle Patient ID

Query parameters

typestring

Subscription Type

monitoring_planstring

Monitoring Plan name, as configured for your organization or provided by Particle for all organizations (for example ACTIVE or PASSIVE); your organization's plans are checked first. Matched case-insensitively. Only return the subscription if the patient is enrolled on this plan; patients with no explicit plan are on your organization's default plan. Returns 404 with error code MONITORING_PLAN_NOT_FOUND if no plan with this name exists for your organization or among Particle's shared plans.

Response

OK

Example response

{
  "subscriptions": [
    {
      "particle_patient_id": "123456",
      "type": "ADT"
    }
  ]
}

Changes