Search prescribers

curl --request GET \
  --url https://api.byblend.com/api/v1/search/prescribers \
  --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",
      "email": "[email protected]",
      "phone": "6417383445",
      "date_of_birth": "1990-01-01",
      "gender": "Male",
      "npi": "1234567890",
      "dea": "F91234563",
      "spi": "1234567890ABCDEF",
      "driver_license_number": "B49188319",
      "driver_license_state": "CA",
      "is_active": true,
      "credential_npi": "M.D./Ph.D",
      "addresses": [
        {
          "address_1": "140 Lindgren Streets",
          "city": "North Consueloburgh",
          "state": "CA",
          "zip_code": "02108",
          "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
          "created_at": "2025-03-15T12:00:00Z",
          "updated_at": "2025-03-15T12:00:00Z",
          "address_2": "Apt 227",
          "country": "US",
          "type": "practice"
        }
      ],
      "qualifications": [
        {
          "state": "CA",
          "license_number": "1234567890",
          "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
          "created_at": "2025-03-15T12:00:00Z",
          "updated_at": "2025-03-15T12:00:00Z",
          "description": "Nurse Practitioner, Family",
          "expiration_date": "2025-03-15",
          "is_active": true
        }
      ],
      "credentials": [
        {
          "credential_code": "MD",
          "credential_name": "Doctor of Medicine"
        }
      ],
      "restrictions": [
        {
          "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
          "name": "Mupirocin",
          "sku": "1234567890"
        }
      ]
    }
  ]
}

GET

api

prescribers

Search prescribers

curl --request GET \
  --url https://api.byblend.com/api/v1/search/prescribers \
  --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",
      "email": "[email protected]",
      "phone": "6417383445",
      "date_of_birth": "1990-01-01",
      "gender": "Male",
      "npi": "1234567890",
      "dea": "F91234563",
      "spi": "1234567890ABCDEF",
      "driver_license_number": "B49188319",
      "driver_license_state": "CA",
      "is_active": true,
      "credential_npi": "M.D./Ph.D",
      "addresses": [
        {
          "address_1": "140 Lindgren Streets",
          "city": "North Consueloburgh",
          "state": "CA",
          "zip_code": "02108",
          "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
          "created_at": "2025-03-15T12:00:00Z",
          "updated_at": "2025-03-15T12:00:00Z",
          "address_2": "Apt 227",
          "country": "US",
          "type": "practice"
        }
      ],
      "qualifications": [
        {
          "state": "CA",
          "license_number": "1234567890",
          "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
          "created_at": "2025-03-15T12:00:00Z",
          "updated_at": "2025-03-15T12:00:00Z",
          "description": "Nurse Practitioner, Family",
          "expiration_date": "2025-03-15",
          "is_active": true
        }
      ],
      "credentials": [
        {
          "credential_code": "MD",
          "credential_name": "Doctor of Medicine"
        }
      ],
      "restrictions": [
        {
          "id": "0227d1e5-ba9a-42b5-8fe2-38882aa65708",
          "name": "Mupirocin",
          "sku": "1234567890"
        }
      ]
    }
  ]
}

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:

"tabitha"

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 prescribers

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.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.gender

string

Gender of the prescriber

Example:

"Male"

results.npi

string

National Provider Identifier

Example:

"1234567890"

results.dea

string

DEA Registration Number

Example:

"F91234563"

results.spi

string

Surescripts Provider ID

Example:

"1234567890ABCDEF"

results.driver_license_number

string

Driver's license number

Example:

"B49188319"

results.driver_license_state

string

Two-letter state abbreviation

Example:

"CA"

results.is_active

boolean

Whether the prescriber is currently active

Example:

true

results.credential_npi

string

Direct credential text as provided by the NPI registry

Example:

"M.D./Ph.D"

results.addresses

object[]

Show child attributes

results.addresses.address_1

string

required

Example:

"140 Lindgren Streets"

results.addresses.city

string

required

Example:

"North Consueloburgh"

results.addresses.state

string

required

Two-letter state abbreviation

Example:

"CA"

results.addresses.zip_code

string

required

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

Example:

"02108"

results.addresses.id

string<uuid>

Unique identifier

Example:

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

results.addresses.created_at

string<date-time>

Date and time of creation

Example:

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

results.addresses.updated_at

string<date-time>

Date and time of last update

Example:

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

results.addresses.address_2

string

Example:

"Apt 227"

results.addresses.country

string

Two-letter country code, defaults to US

Example:

"US"

results.addresses.type

string

Type of address, either 'practice' or 'working'

Example:

"practice"

results.qualifications

object[]

Show child attributes

results.qualifications.state

string

required

Example:

"CA"

results.qualifications.license_number

string

required

License number for the prescriber in this state. Note that when a state qualification is updated with a new license number, the old qualification will be automatically deactivated.

Example:

"1234567890"

results.qualifications.id

string<uuid>

Unique identifier

Example:

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

results.qualifications.created_at

string<date-time>

Date and time of creation

Example:

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

results.qualifications.updated_at

string<date-time>

Date and time of last update

Example:

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

results.qualifications.description

string

Description of the license qualification

Example:

"Nurse Practitioner, Family"

results.qualifications.expiration_date

string<date>

Example:

"2025-03-15"

results.qualifications.is_active

boolean

Example:

true

results.credentials

object[]

Show child attributes

results.credentials.credential_code

string

Example:

"MD"

results.credentials.credential_name

string

Example:

"Doctor of Medicine"

results.restrictions

object[]

Show child attributes

results.restrictions.id

string<uuid>

Unique identifier

Example:

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

results.restrictions.name

string

Example:

"Mupirocin"

results.restrictions.sku

string

Example:

"1234567890"

Search patients Search products

⌘I

Authentication

Composite Creation

Electronic Prescriptions

Notifications

Orders

Patients

Prescribers

Products and Materials

Reports

Search

Search prescribers

Authorizations

Query Parameters

Response