GET
/
api
/
v1
/
search
curl --request GET \
  --url https://api.byblend.com/api/v1/search \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "rank": 0.7,
      "result_type": "patient",
      "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": "Harmon43@gmail.com",
      "phone": "6417383445",
      "date_of_birth": "1990-01-01",
      "driver_license_number": "B49188319",
      "driver_license_state": "CA",
      "primary_language": "en",
      "guardian_name": "John Guardian",
      "guardian_phone": "6417383445",
      "guardian_email": "parent@example.com",
      "guardian_relationship": "parent",
      "height_inches": 72,
      "weight_pounds": 180,
      "external_id": "1234567890",
      "is_smoker": false,
      "is_diabetic": false,
      "is_pregnant": false,
      "address": {
        "address_1": "140 Lindgren Streets",
        "address_2": "Apt 227",
        "city": "North Consueloburgh",
        "state": "CA",
        "country": "US",
        "zip_code": "02108"
      },
      "is_minor": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
q
string
required

Search query. Enclose phrases in URL-escaped quotes to search for an exact phrase, e.g. "Joe Public." Searchable fields include ID, order number, name, email, phone, prescriber identifiers, product name and SKU. Substring search is supported for all fields.

Example:

"1234567890"

​
limit
integer

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

Example:

100

Response

200 - application/json

Successful response with array of search results, ordered by relevance. The result_type in each item is one of order, patient, prescriber, prescription, non_prescription, order_material, or task.

The response is of type object.