Search patients

curl --request GET \
  --url https://api.byblend.com/api/v1/search/patients \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "rank": 0.7,
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "first_name": "Willard",
      "middle_name": "Moises",
      "last_name": "Donnelly",
      "gender": "male",
      "email": "[email protected]",
      "phone": "6417383445",
      "date_of_birth": "1990-01-01",
      "driver_license_number": "B49188319",
      "driver_license_state": "CA",
      "ssn": "123456789",
      "primary_language": "en",
      "guardian_name": "John Guardian",
      "guardian_phone": "6417383445",
      "guardian_email": "[email protected]",
      "guardian_relationship": "parent",
      "height_inches": 72,
      "weight_pounds": 180,
      "external_id": "1234567890",
      "is_smoker": false,
      "is_diabetic": false,
      "is_pregnant": false,
      "receive_sms": true,
      "receive_email": true,
      "address": {
        "address_1": "140 Lindgren Streets",
        "city": "North Consueloburgh",
        "state": "CA",
        "zip_code": "02108",
        "address_2": "Apt 227",
        "country": "US"
      },
      "is_minor": false
    }
  ]
}

GET

api

patients

Search patients

curl --request GET \
  --url https://api.byblend.com/api/v1/search/patients \
  --header 'Authorization: Bearer <token>'

{
  "results": [
    {
      "rank": 0.7,
      "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
      "created_at": "2025-03-15T12:00:00Z",
      "updated_at": "2025-03-15T12:00:00Z",
      "first_name": "Willard",
      "middle_name": "Moises",
      "last_name": "Donnelly",
      "gender": "male",
      "email": "[email protected]",
      "phone": "6417383445",
      "date_of_birth": "1990-01-01",
      "driver_license_number": "B49188319",
      "driver_license_state": "CA",
      "ssn": "123456789",
      "primary_language": "en",
      "guardian_name": "John Guardian",
      "guardian_phone": "6417383445",
      "guardian_email": "[email protected]",
      "guardian_relationship": "parent",
      "height_inches": 72,
      "weight_pounds": 180,
      "external_id": "1234567890",
      "is_smoker": false,
      "is_diabetic": false,
      "is_pregnant": false,
      "receive_sms": true,
      "receive_email": true,
      "address": {
        "address_1": "140 Lindgren Streets",
        "city": "North Consueloburgh",
        "state": "CA",
        "zip_code": "02108",
        "address_2": "Apt 227",
        "country": "US"
      },
      "is_minor": false
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

string

required

Search query

Example:

"Rodrigo Davis"

limit

integer

Optional limit on the number of results to return. Max is 100, default is 50.

Example:

10

Response

200 - application/json

Successful response with array of patients

results

object[]

Show child attributes

results.rank

number

Ranking score of the search result, from 0 to 1, indicating relevance to the search query

Example:

0.7

results.id

string<uuid>

Unique identifier

Example:

"0227d1e5-ba9a-42b5-8fe2-38882aa65708"

results.created_at

string<date-time>

Date and time of creation

Example:

"2025-03-15T12:00:00Z"

results.updated_at

string<date-time>

Date and time of last update

Example:

"2025-03-15T12:00:00Z"

results.first_name

string

Example:

"Willard"

results.middle_name

string

Example:

"Moises"

results.last_name

string

Example:

"Donnelly"

results.gender

enum<string>

Gender of the patient

Available options:

male,

female

Example:

"male"

results.email

string

Example:

"[email protected]"

results.phone

string

10-digit phone number without formatting, e.g. 6417383445

Example:

"6417383445"

results.date_of_birth

string<date>

Example:

"1990-01-01"

results.driver_license_number

string

Example:

"B49188319"

results.driver_license_state

string

Example:

"CA"

results.ssn

string

Social Security number. Can be provided with or without hyphens.

Example:

"123456789"

results.primary_language

string

ISO 639-1 language code

Example:

"en"

results.guardian_name

string

Name of the patient's guardian. Required if patient is a minor.

Example:

"John Guardian"

results.guardian_phone

string

Example:

"6417383445"

results.guardian_email

string

Example:

"[email protected]"

results.guardian_relationship

string

Relationship of the guardian to the patient. See relationship types lookup for available values; most common are parent and legal_guardian; and other can be used.

Example:

"parent"

results.height_inches

integer

Height of the patient in inches

Example:

72

results.weight_pounds

integer

Weight of the patient in pounds

Example:

180

results.external_id

string

External (your own) ID for the patient, to be used for prescription matching

Example:

"1234567890"

results.is_smoker

boolean

Whether the patient is a smoker

Example:

false

results.is_diabetic

boolean

Whether the patient is diabetic

Example:

false

results.is_pregnant

boolean

Whether the patient is pregnant

Example:

false

results.receive_sms

boolean

Whether the patient should receive SMS notifications for shipments. This is only applicable if you have authorized Blend to send patient communications on your behalf.

Example:

true

results.receive_email

boolean

Whether the patient should receive email notifications for shipments. This is only applicable if you have authorized Blend to send patient communications on your behalf.

Example:

true

results.address

object

Show child attributes

results.address.address_1

string

required

Example:

"140 Lindgren Streets"

results.address.city

string

required

Example:

"North Consueloburgh"

results.address.state

string

required

Two-letter state abbreviation

Example:

"CA"

results.address.zip_code

string

required

5-digit ZIP code or 9-digit ZIP+4 code, e.g. 02108 or 02108-1234.

Example:

"02108"

results.address.address_2

string

Example:

"Apt 227"

results.address.country

string

Two-letter country code, defaults to US

Example:

"US"

results.is_minor

boolean

Whether the patient is a minor. Automatically calculated based on date of birth.

Example:

false

Search orders Search prescribers

⌘I

Authentication

Composite Creation

Electronic Prescriptions

Notifications

Orders

Patients

Prescribers

Products and Materials

Reports

Search

Search patients

Authorizations

Query Parameters

Response