Skip to content

List patient category enrollments (account-wide)

Request

Retrieve patient-category enrollments across the account, filterable by category and current CRM status. Each row carries the patientId and assignedAt (when the patient entered the current status). Use /patient/{patientId} to hydrate the patient.

Security
PartnerApiKey and PartnerOAuth
Path
accountIdinteger, (int64)required

Account identifier

Query
categoryIdinteger, (int64)

Filter by category ID

crmStatusIdinteger, (int64)

Filter by current CRM status ID

activeboolean

Filter by active status (true/false)

sortBystring(?i)NAME|CREATED_DATE

Sort by field

Default:"CREATED_DATE"
Enum:"NAME""CREATED_DATE"
sortDirstring(?i)ASC|DESC

Sort direction

Default:"DESC"
Enum:"ASC""DESC"
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-category?categoryId=0&crmStatusId=0&active=true&sortBy=NAME&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Patient category enrollments retrieved successfully

Bodyapplication/json
categoriesArray of objects(PatientCategoryDTO)

List of patient category assignments

nextCursorstring

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

Response
{ "categories": [ {} ], "nextCursor": "string" }