List patient category assignments

Request

Retrieve the patient's category assignments. By default returns all assignments; use the 'active' filter to narrow results.

Security

PartnerApiKey and PartnerOAuth

Path

patientIdinteger, (int64)required

Patient ID (AccountPatient id)

accountIdinteger, (int64)required

Account identifier

Query

activeboolean

Filter by active status (true/false)

categoryIdinteger, (int64)

Filter by category ID

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/{patientId}/category?active=true&categoryId=0&sortBy=NAME&sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Patient categories 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"
}