Patients

List patients

Request

Retrieve a paginated list of patients for the account. Supports filtering by name/email/active status and cursor-based pagination.

Security

PartnerApiKey and PartnerOAuth

Path

accountIdinteger, (int64)required

Account identifier

Query

firstNamestring, [ 0 .. 100 ] characters

Filter patients by first name (case-insensitive contains match)

Example:firstName=John

lastNamestring, [ 0 .. 100 ] characters

Filter patients by last name (case-insensitive contains match)

Example:lastName=Smith

emailstring, [ 0 .. 254 ] characters

Filter patients by email (case-insensitive contains match)

Example:email=example@lobbie.com

activeboolean

Filter patients by active status. Omit to return patients regardless of status; active=false returns archived or merged-away records.

Example:active=true

cursorstring, [ 0 .. 2048 ] characters

Pagination cursor from previous response

limitinteger, (int32), [ 1 .. 1000 ]

Number of results per page (max 1000)

Default:20

Example:limit=20

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/patient?firstName=John&lastName=Smith&email=example%40lobbie.com&active=true&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Patients retrieved successfully

Bodyapplication/json

nextCursorstring

Opaque cursor for fetching the next page. Null if no more results.

Example:"eyJ2Ijp7ImZpcnN0TmFtZSI6IkpvaG4ifSwiaWQiOjEyMzQ1fQ"

patientsArray of objects(PatientResponse)

List of patients in this page

Response