Skip to content

List patient tags

Request

Retrieve the patient's active tags, ordered by display order. Cursor-based pagination.

Security
PartnerApiKey and PartnerOAuth
Path
patientIdinteger, (int64)required

Patient ID (AccountPatient id)

accountIdinteger, (int64)required

Account identifier

Query
sortDirstring(?i)ASC|DESC

Sort direction by display order

Default:"ASC"
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}/tag?sortDir=ASC&cursor=string&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Tags retrieved successfully

Bodyapplication/json
nextCursorstring

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

tagsArray of objects(TagDTO)

List of patient tags

Response
{
  "nextCursor": "string",
  "tags": [
    { … }
  ]
}