Get form packet by ID

Request

Retrieve detailed information about a form packet including all forms and their completion status. Use the form sub-resource endpoints to retrieve answers.

Security

PartnerApiKey and PartnerOAuth

Path

formPacketIdinteger, (int64)required

Form packet ID

Example:12345

accountIdinteger, (int64)required

Account identifier

locationIdinteger, (int64)required

Location identifier

curl -i -X GET \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/location/{locationId}/form-packet/12345' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Form packet found and returned successfully

Bodyapplication/json

completedAtstring, (date-time)

Completion timestamp. Not monotonic: can transition back to null and re-set if forms are added to a completed packet, an EHR sync retracts completion, or staff manually clear it. Treat each form-packet.updated event as a state snapshot, not a terminal completion signal.

Example:"2025-01-18T14:30:00-05:00"

createdAtstring, (date-time)

Creation timestamp (UTC)

Example:"2025-01-15T14:00:00Z"

dueDatestring, (date-time)

Due date for completion (ISO 8601)

Example:"2025-01-20T17:00:00-05:00"

formTemplateIdsArray of integers

Form template IDs for the forms in this packet

Example:

idinteger, (int64)

Unique form packet identifier

Example:12345

isActiveboolean

Whether the form packet is active. Inactive packets have been deactivated by the system (e.g. via appointment cancellation).

Example:true

isArchivedboolean

Whether the form packet has been archived via DELETE or PUT.

Example:false

locationIdinteger, (int64)

Location ID

Example:111

locationNamestring

Location name

Example:"Main Street Clinic"

patientIdinteger, (int64)

Patient ID

Example:67890

patientNamestring

Patient name

Example:"John Doe"

updatedAtstring, (date-time)

Last update timestamp (UTC)

Example:"2025-01-15T14:00:00Z"

Response

{
  "completedAt": "2025-01-18T14:30:00-05:00",
  "createdAt": "2025-01-15T14:00:00Z",
  "dueDate": "2025-01-20T17:00:00-05:00",
  "formTemplateIds": [
    101,
    102
  ],
  "id": 12345,
  "isActive": true,
  "isArchived": false,
  "locationId": 111,
  "locationName": "Main Street Clinic",
  "patientId": 67890,
  "patientName": "John Doe",
  "updatedAt": "2025-01-15T14:00:00Z"
}