List form packets

Request

Retrieve a paginated list of form packets for the account. Supports filtering by patient, location, and date range. Form packets contain one or more forms assigned to a patient.

Security

PartnerApiKey and PartnerOAuth

Path

accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

Query

patientIdinteger, (int64)

Filter by patient ID

formTemplateIdinteger, (int64)

Filter by form template ID

startDatestring

Start of date range filter on the form packet due date (ISO 8601)

endDatestring

End of date range filter on the form packet due date (ISO 8601)

sortBystring

Sort by (DUE_DATE, CREATED_DATE, ID)

Default:"CREATED_DATE"

Enum:"DUE_DATE""CREATED_DATE""ID"

sortDirstring

Sort direction

Default:"DESC"

Enum:"ASC""DESC"

cursorstring

Pagination cursor from previous response

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

Number of results per page (max 1000)

Default:20

Example:limit=20

activeboolean

Filter by internal active flag. Active packets are those that have not been deactivated by the system (e.g. via appointment cancellation). If not specified, returns both active and inactive form packets.

Enum:truefalse

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/form-packet?patientId=0&formTemplateId=0&startDate=string&endDate=string&sortBy=DUE_DATE&sortDir=ASC&cursor=string&limit=20&active=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Form packets retrieved successfully

Bodyapplication/json

formPacketsArray of objects(FormPacketDTO)

List of form packets in this page

nextCursorstring

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

Response

{
  "formPackets": [
    { … }
  ],
  "nextCursor": "string"
}