# Lobbie Partner API # Partner API Overview ## Authentication The Partner API uses **OAuth 2.0 with AWS Cognito** for secure machine-to-machine (M2M) authentication. ### Prerequisites Before making API requests, you must complete the partner onboarding process: 1. **Partner Registration**: Lobbie creates a partner integrator record with your unique `client_id` 2. **Cognito Credentials**: Lobbie provides OAuth 2.0 client credentials (client ID and client secret) 3. **API Gateway Key**: Lobbie provides an `x-api-key` value that identifies your integration for rate limiting (see [Rate Limits & Quotas](#rate-limits--quotas)) 4. **Account Grants**: Lobbie grants your integration access to specific accounts All three credentials (`client_id`, `client_secret`, and `x-api-key`) are shown **only once** at onboarding — store them securely. If any are lost or compromised, contact Lobbie support immediately. ### Obtaining an Access Token Request an access token using the OAuth 2.0 client credentials by sending an HTTPS form POST. **Include the `x-api-key` header** — the token endpoint is gated by the same API key as the rest of the Partner API: ``` POST https://api.lobbie.com/oauth2/token Content-Type: application/x-www-form-urlencoded x-api-key: grant_type=client_credentials& scope=prod-lobbie-api/partner-api& client_id=& client_secret= ``` The `scope` value is environment-prefixed. Use `prod-lobbie-api/partner-api` for production; Lobbie will provide the appropriate value for any non-production environment at onboarding. The response contains a JWT access token: ```json { "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...", "token_type": "Bearer", "expires_in": 3600 } ``` > **Cache this token.** Tokens are valid for 60 minutes and the token endpoint has a much tighter rate limit than the main API (see [Rate Limits & Quotas](#rate-limits--quotas)). A well-behaved integration fetches a token _once_ and reuses it until shortly before it expires. ### Making Authenticated Requests Every API request must include **both** headers: the OAuth Bearer token (which authenticates you) and the API key (which identifies you to the gateway for rate limiting): ``` Authorization: Bearer x-api-key: ``` Requests missing the `x-api-key` header are rejected at the API Gateway edge with `403 Forbidden` before reaching the application. Requests with an invalid or revoked key are similarly rejected. ### Token Management - Access tokens expire after the duration specified in `expires_in` (default: 60 minutes) - Request a new token before the current one expires - Store credentials securely—they grant access to protected health information (PHI) - If credentials are compromised, contact Lobbie support immediately to revoke and regenerate ### Authorization Your partner integration must have an active grant to access each account. The API validates: 1. The JWT token is valid and not expired 2. Your `client_id` corresponds to an active partner integrator 3. Your integration has an active grant to the requested account 4. The requested location belongs to the specified account ## Rate Limits & Quotas Limits are enforced per `x-api-key`. Two separate limits apply depending on which endpoint you're calling: **General API (`/lobbie/api/partner/v2/*`)** — sustained rate limit **25 requests/second** with a **daily quota of 250,000 requests**. We recommend targeting around **20 requests/second** in steady-state to absorb natural timing variability. **Token endpoint (`/oauth2/token`)** — enforced at a much tighter per-partner rate than the rest of the API. A correctly-implemented integration fetches a token _once per hour_ and caches it until shortly before it expires; with that behavior you'll never approach the limit. If you're seeing 429s on `/oauth2/token`, your client is refreshing tokens far more often than needed — add caching rather than asking for a higher limit. Token calls count against the same daily quota as the rest of the API. The daily quota resets at 00:00 UTC. Exceeding a limit returns `429 Too Many Requests`: | Cause | Response body | Recovery | | --------------------- | --------------------------------- | ---------------------------------------------------------- | | Rate too high | `{"message":"Too Many Requests"}` | Back off briefly and retry — capacity refills in seconds | | Daily quota exhausted | `{"message":"Limit Exceeded"}` | Wait until 00:00 UTC, or contact Lobbie for a higher quota | If your integration consistently approaches these limits, contact Lobbie. ## Common Errors | Status | Error | Description | | ------ | ----------------- | --------------------------------------------------------------------------------------------- | | 401 | Unauthorized | Invalid, expired, or missing access token | | 403 | Forbidden | Missing/invalid `x-api-key`, or integration lacks access to the requested account or location | | 404 | Not Found | Resource not found or does not belong to the authorized account | | 429 | Too Many Requests | Rate limit or daily quota exceeded (see [Rate Limits & Quotas](#rate-limits--quotas)) | ## HIPAA & Compliance - All patient data is Protected Health Information (PHI) - Encrypt data at rest and in transit - Maintain audit logs of all data access - Sign Business Associate Agreement (BAA) before production access - Follow data retention policies per agreement --- # Terminology This glossary defines domain-specific terms used throughout the Lobbie Partner API. --- ## Core Entities ### Account A healthcare practice or organization using Lobbie. Each account contains practice-wide settings and configurations, and can have multiple locations. All API access is scoped to a specific account via OAuth tokens. ### Location A physical practice site, clinic, or virtual care location within an account. Locations have their own addresses, staff assignments, schedules, and operational settings. Appointments, forms, and many operations are location-scoped. Each location has timezone information critical for accurate scheduling. Locations may have an optional `storeId` that partners can use to correlate Lobbie locations with their own systems. ### Patient An individual receiving healthcare services from a specific account. Contains demographic information (name, date of birth) and contact details (email, phone). Serves as the central entity linking appointments, forms, invoices, and clinical data. Subject to HIPAA privacy requirements. --- ## Scheduling ### Appointment A scheduled visit between a patient and practitioner at a specific location and time. Appointments track the complete visit lifecycle from initial scheduling through check-in, the visit itself, and completion or cancellation. Each appointment links to an appointment type, patient, practitioner, and location. ### Appointment Type A template defining a schedulable service, including duration, telehealth settings, display color, and patient-facing description/instructions. Examples: "New Patient Consultation" (30 min), "Follow-up Visit" (15 min), "Telehealth Checkup" (20 min). Appointment types determine what services patients can book and how long they're scheduled. ### Practitioner A staff member designated as a clinical provider who can see patients and be scheduled for appointments. Practitioners have credentials (MD, DO, NP, PA, RN), NPI numbers, specialties, and license information. All practitioners are staff members, but not all staff are practitioners. ### Self-Scheduling Patient-initiated appointment booking through embeddable widgets or API integration. Self-scheduling respects practice availability rules, appointment type configurations, and booking windows. Patients can browse available times and complete bookings without staff intervention. ### Self-Scheduling Attempt A record of a patient's journey through the self-scheduling process, from initiation to completion or abandonment. Captures step-by-step progress for conversion analysis, identifying drop-off points, and triggering follow-up workflows for incomplete attempts. --- ## Staff & Access ### Staff Member Any team member with system access, including administrative staff, clinical support, and practitioners. Staff have role assignments determining their permissions and location access. ### Role Group A permission set defining capabilities and access levels for staff members. Role groups control what actions staff can perform within the system, from standard user access to full administrative privileges. Staff members can have multiple role groups assigned, combining permissions as needed. --- ## Forms & Documentation ### Form Template A reusable form design defining structure, fields, validation rules, and conditional logic. Templates are created once and used to generate form instances for patients. Form templates support versioning—when a template is modified, a new version is created while preserving previous versions for historical form submissions. Examples: "Patient Intake Form", "HIPAA Consent", "Medical History Questionnaire". ### Form Group A collection of one or more form instances assigned to a patient for completion. Form groups track overall completion status and can include multiple related forms. A form group is considered complete when all forms within it have been submitted, and can be archived when no longer needed. ### Form An individual form instance within a form group, based on a form template version. Each form tracks its own completion status and contains the patient's responses. ### Form Element A single field or component within a form template that captures patient input or displays content. Element types include: text inputs, text areas, dropdowns, checkboxes, radio buttons, date pickers, signatures, initials, file uploads, phone numbers, email addresses, addresses, and specialized types like payment fields and body diagrams. Elements can be configured as required or optional, and can have visibility rules controlling who can view or edit them (patient only, staff only, or both). ### Form Answer A patient's response to a specific form element. Answers are stored per element and can be text, selections, dates, signatures, or file uploads depending on the element type. ### Form Template Group A predefined collection of form templates commonly assigned together. Simplifies assigning multiple related forms in a single operation (e.g., "New Patient Packet" containing intake, consent, and history forms). --- ## Billing & Payments ### Invoice An itemized billing statement for a patient detailing charges for services, products, taxes, and fees. Invoices progress through a lifecycle from creation to payment or cancellation. Invoices can be linked to appointments or created independently. ### Invoice Line Item A single charge entry within an invoice. Line items specify quantity, unit price, and description, and can represent services, products, adjustments, or taxes. May reference billing codes and associated care resources. ### Payment Request A trackable record of a payment’s lifecycle, from initiation to final settlement. Each request tracks its status from creation through payment or expiration, whether triggered as a remote request sent to a patient (via email or SMS) or entered directly by staff for immediate processing. ### Recurring Payment An automated payment plan with scheduled charges at defined intervals. Used for payment plans, memberships, and subscription services. Configured with a frequency (weekly, monthly, etc.), amount, linked payment method, and optional end date. --- ## Labs & Clinical ### Lab A laboratory order containing one or more test panels with results. Labs track progress from order placement through result delivery. Labs can be in-house or from external vendors and link to patients and optionally appointments. ### Test Panel A grouping of related lab tests within a lab order. Examples: "Comprehensive Metabolic Panel", "Complete Blood Count", "Lipid Panel". Each panel contains multiple test components. ### Test Component An individual lab measurement within a test panel. Contains the test name, result value, unit of measurement, reference range, and an indicator of whether the result is normal or abnormal. ### Health Profile Structured patient health information including medical history, allergies, medications, and clinical data collected through intake forms and clinical encounters. --- ## Patient Management ### Category A service category that can function as either a CRM-tracked sales pipeline or a simple organizational tag. When CRM-tracked, categories enable full pipeline tracking through status stages with dashboard visibility. When not CRM-tracked, categories function as simple groupings for billing, inventory, or reporting. Examples of CRM categories: "Men's Health - Testosterone", "Weight Loss - Semaglutide". Examples of simple categories: "Lab Supplies", "Office Visits". ### Patient Category A patient's enrollment in a specific service category with CRM status tracking. Represents the link between a patient and a category, tracking their progress through the associated CRM pipeline. Appears as an "Opportunity" in CRM dashboards. Tracks status transitions with a complete audit trail. ### CRM Status Group A reusable CRM workflow pipeline (sales/marketing funnel) that defines the customer journey stages. Think of it as the sales funnel template—the workflow (HOW you sell) is separated from the product (WHAT you sell). Multiple categories often share the same sales process. Examples: "Digital Marketing Funnel" with stages like Cold Lead → Engaged → Sales Qualified → Closed Won; "Patient Care Journey" with stages like Intake → Insurance Verified → In Treatment → Complete. ### CRM Status An individual stage within a CRM status group representing where a patient is in a workflow. Status progression is tracked through transitions, providing a complete audit trail. Examples: "Cold Lead", "Sales Qualified", "Proposal Sent", "Closed Won", "Closed Lost". --- ## Communications ### Notification A system-generated message sent to a patient via email or SMS. Notifications are sent for various purposes including appointment reminders, form assignments, payment requests, and account recovery. Each notification tracks its delivery status. ### Notification Group Configuration defining how and when patients receive specific types of communications, customizable per location or appointment type. --- ## Identity & Security ### Identity Proof A verification session for authenticating patient identity through email and/or SMS code verification. Used for patient portal authentication, self-scheduling verification, and secure access to patient data. Each session generates a secure token and tracks which contact methods have been verified. ### Verification Method The channel(s) required to prove identity, which can be email only, SMS only, or both. The verification method determines what must be verified before the identity proof is considered complete. Version: 2.0 ## Servers Production ``` https://api-prod.lobbie.com/lobbie/api ``` ## Security ### PartnerApiKey API Gateway key issued at partner onboarding. Required in addition to the OAuth Bearer token — the key identifies the partner to the gateway for rate limiting. See 'Rate Limits & Quotas' in the overview. Type: apiKey In: header Name: x-api-key ### PartnerOAuth OAuth 2.0 access token from integration webhook Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Lobbie Partner API](https://api-docs.lobbie.com/_bundle/openapi.yaml) ## Account Account endpoints ### Get account - [GET /partner/v2/account/{accountId}](https://api-docs.lobbie.com/openapi/account/getaccount.md): Retrieve account information and settings for the authorized account. ## Appointment Types Appointment Type configuration endpoints ### List appointment types - [GET /partner/v2/account/{accountId}/appointment/type](https://api-docs.lobbie.com/openapi/appointment-types/listappointmenttypes.md): Retrieve a paginated list of active appointment types for the account. Supports filtering by name/description and keyset pagination. ### Get appointment type by ID - [GET /partner/v2/account/{accountId}/appointment/type/{appointmentTypeId}](https://api-docs.lobbie.com/openapi/appointment-types/getappointmenttype.md): Retrieve details for a specific appointment type. ## Appointments Appointment scheduling and management endpoints ### List appointments - [GET /partner/v2/account/{accountId}/location/{locationId}/appointment](https://api-docs.lobbie.com/openapi/appointments/listappointments.md): Retrieve a paginated list of appointments for the account. Supports filtering by location, practitioner, patient, date range, and status. Results are sorted by appointment start time by default. ### Create appointment - [POST /partner/v2/account/{accountId}/location/{locationId}/appointment](https://api-docs.lobbie.com/openapi/appointments/createappointment.md): Schedule a new appointment for a patient. Requires patient ID, practitioner ID, appointment type ID, scheduler config ID, and the desired start time. The system will validate availability before confirming the appointment. ### Get appointment by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/appointment/{appointmentId}](https://api-docs.lobbie.com/openapi/appointments/getappointment.md): Retrieve detailed information about a specific appointment including patient details, practitioner, location, and appointment type information. ### Update appointment - [PUT /partner/v2/account/{accountId}/location/{locationId}/appointment/{appointmentId}](https://api-docs.lobbie.com/openapi/appointments/updateappointment.md): Update an existing appointment. Can be used to reschedule (change time/practitioner) or update appointment details. Only provided fields will be updated. ## CRM Status Groups CRM status retrieval endpoints ### List CRM status groups - [GET /partner/v2/account/{accountId}/crm-status-group](https://api-docs.lobbie.com/openapi/crm-status-groups/listcrmstatusgroups.md): Retrieve the list of CRM status groups defined for the account. ### Get CRM status group by ID - [GET /partner/v2/account/{accountId}/crm-status-group/{groupId}](https://api-docs.lobbie.com/openapi/crm-status-groups/getcrmstatusgroup.md): Retrieve detailed information about a specific CRM status group. ### List CRM statuses in group - [GET /partner/v2/account/{accountId}/crm-status-group/{groupId}/status](https://api-docs.lobbie.com/openapi/crm-status-groups/listcrmstatuses.md): Retrieve all CRM statuses within the specified status group. ### Get CRM status by ID - [GET /partner/v2/account/{accountId}/crm-status-group/{groupId}/status/{statusId}](https://api-docs.lobbie.com/openapi/crm-status-groups/getcrmstatus.md): Retrieve detailed information about a specific CRM status. ## Categories Patient category definition retrieval endpoints ### List categories - [GET /partner/v2/account/{accountId}/category](https://api-docs.lobbie.com/openapi/categories/listcategories.md): Retrieve the list of patient categories defined for the account. ### Get category by ID - [GET /partner/v2/account/{accountId}/category/{categoryId}](https://api-docs.lobbie.com/openapi/categories/getcategory.md): Retrieve detailed information about a specific category. ## Form Template Groups Form template group retrieval endpoints ### List form template groups - [GET /partner/v2/account/{accountId}/form/template-group](https://api-docs.lobbie.com/openapi/form-template-groups/listformtemplategroups.md): Retrieve a list of form template groups for the account. Form template groups are pre-configured collections of forms that can be assigned together. ### Get form template group by ID - [GET /partner/v2/account/{accountId}/form/template-group/{groupId}](https://api-docs.lobbie.com/openapi/form-template-groups/getformtemplategroup.md): Retrieve detailed information about a form template group including the list of form templates it contains. ## Form Templates Form template reference data ### List form templates - [GET /partner/v2/account/{accountId}/location/{locationId}/form/template](https://api-docs.lobbie.com/openapi/form-templates/listformtemplates.md): Retrieve a paginated list of form templates for the account. Templates define the structure of forms that can be assigned to patients. Supports filtering by appointment type and staff-only visibility. ### Get form template by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/form/template/{formTemplateId}](https://api-docs.lobbie.com/openapi/form-templates/getformtemplate.md): Retrieve detailed information about a form template including all form elements/fields. Use this to understand the structure of a form for integration purposes. ### Get form template attributes - [GET /partner/v2/account/{accountId}/location/{locationId}/form/template/{formTemplateId}/attribute](https://api-docs.lobbie.com/openapi/form-templates/getformtemplateattributes.md): Retrieve the list of mapped attributes for a template. Attributes are named mappings for form fields (e.g., 'patient_first_name') that can be used for pre-filling and data extraction. ### Get form template elements - [GET /partner/v2/account/{accountId}/location/{locationId}/form/template/{formTemplateId}/element](https://api-docs.lobbie.com/openapi/form-templates/getformtemplateelements.md): Retrieve the list of form elements (fields) for a template. Each element represents an input field, with its type, label, and optional attribute mapping. ## Forms Individual form operations within a form packet ### List form packets - [GET /partner/v2/account/{accountId}/location/{locationId}/form-packet](https://api-docs.lobbie.com/openapi/forms/listformpackets.md): Retrieve a paginated list of form packets for the account. Supports filtering by patient, location, status, and date range. Form packets contain one or more forms assigned to a patient. ### Create form packet - [POST /partner/v2/account/{accountId}/location/{locationId}/form-packet](https://api-docs.lobbie.com/openapi/forms/createformpacket.md): Create a new form packet for a patient. Specify the patient and either a list of form template IDs or a form template group ID. Optionally set a due date and pre-fill form fields with known data using attribute name keys (see the prefill field for details). Use GET /form/template/{id}/attribute to discover available attribute names for a template. ### Archive form packet - [DELETE /partner/v2/account/{accountId}/location/{locationId}/form-packet/{formPacketId}](https://api-docs.lobbie.com/openapi/forms/archiveformpacket.md): Archive a form packet. Archived packets are hidden from default views but can still be retrieved by filtering for ARCHIVED status. ### Get form packet by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/form-packet/{formPacketId}](https://api-docs.lobbie.com/openapi/forms/getformpacket.md): Retrieve detailed information about a form packet including all forms and their completion status. Use the form sub-resource endpoints to retrieve answers. ### Update form packet - [PUT /partner/v2/account/{accountId}/location/{locationId}/form-packet/{formPacketId}](https://api-docs.lobbie.com/openapi/forms/updateformpacket.md): Update a form packet. Can be used to change the due date, add additional forms, or update the status. ### List forms in a packet - [GET /partner/v2/account/{accountId}/location/{locationId}/form-packet/{formPacketId}/form](https://api-docs.lobbie.com/openapi/forms/listforms.md): Retrieve all active forms within a form packet, including their completion status and template information. ### Get a single form - [GET /partner/v2/account/{accountId}/location/{locationId}/form-packet/{formPacketId}/form/{formId}](https://api-docs.lobbie.com/openapi/forms/getform.md): Retrieve a single form within a packet, including all submitted answers. ### Update form answers - [PUT /partner/v2/account/{accountId}/location/{locationId}/form-packet/{formPacketId}/form/{formId}](https://api-docs.lobbie.com/openapi/forms/updateformanswers.md): Update answers for a specific form within a packet. Provide a list of answer updates keyed by form element ID. ### Submit a form - [PUT /partner/v2/account/{accountId}/location/{locationId}/form-packet/{formPacketId}/form/{formId}/submit](https://api-docs.lobbie.com/openapi/forms/submitform.md): Mark a form as complete. Once submitted, the form is considered finalized. If all forms in the packet are complete, the packet is also marked complete. ## Health Profile Patient health profile items (allergies, medications, problems) retrieval by ID under account ### Get allergy by ID - [GET /partner/v2/account/{accountId}/health-profile/allergies/{allergyId}](https://api-docs.lobbie.com/openapi/health-profile/getallergy.md): Retrieve detailed information about a specific allergy. Scoped by account. ### Get medication by ID - [GET /partner/v2/account/{accountId}/health-profile/medications/{medicationId}](https://api-docs.lobbie.com/openapi/health-profile/getmedication.md): Retrieve detailed information about a specific medication. Scoped by account. ### Get problem by ID - [GET /partner/v2/account/{accountId}/health-profile/problems/{problemId}](https://api-docs.lobbie.com/openapi/health-profile/getproblem.md): Retrieve detailed information about a specific problem/diagnosis. Scoped by account. ## Identity Proof Account-scoped identity verification endpoints ### Create identity proof - [POST /partner/v2/account/{accountId}/identity-proof](https://api-docs.lobbie.com/openapi/identity-proof/createidentityproof.md): Create a new identity proof session for person verification within this account. Returns an ID and secure token for subsequent requests. ### Get identity proof status - [GET /partner/v2/account/{accountId}/identity-proof/{id}](https://api-docs.lobbie.com/openapi/identity-proof/getidentityproofstatus.md): Returns the current status of an identity proof session, including which verification methods have been verified and which are still pending. ### Get matched patient - [GET /partner/v2/account/{accountId}/identity-proof/{id}/patient](https://api-docs.lobbie.com/openapi/identity-proof/getpatient_1.md): Find the matched patient for a verified identity proof. Returns the patient ID if a unique match is found. Returns 404 if no match found, or 422 if multiple matches found (duplicate email/phone in account). All required communication methods must be verified before calling this endpoint. ### Send verification code - [POST /partner/v2/account/{accountId}/identity-proof/{id}/send](https://api-docs.lobbie.com/openapi/identity-proof/sendverification.md): Send verification code to email or phone. Does not perform patient matching - only proves contact ownership. ### Verify code - [POST /partner/v2/account/{accountId}/identity-proof/{id}/verify](https://api-docs.lobbie.com/openapi/identity-proof/verifycode.md): Verify the code sent via email or SMS. Returns verification status and the verified contact information (email/phone). ## Invoices Invoice retrieval endpoints ### List invoices - [GET /partner/v2/account/{accountId}/location/{locationId}/invoice](https://api-docs.lobbie.com/openapi/invoices/listinvoices.md): Retrieve invoices for the location using cursor pagination. Optional filters: purchase order ID, status, patient ID, subscription ID. ### Get invoice by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/invoice/{invoiceId}](https://api-docs.lobbie.com/openapi/invoices/getinvoice.md): Retrieve a single invoice for the location, including line items. ## Items Item retrieval endpoints ### List items - [GET /partner/v2/account/{accountId}/item](https://api-docs.lobbie.com/openapi/items/listitems.md): Retrieve a paginated list of items (services and supplies) for the account. ### Get item by ID - [GET /partner/v2/account/{accountId}/item/{itemId}](https://api-docs.lobbie.com/openapi/items/getitem.md): Retrieve detailed information about a specific item. ## Labs Lab test component retrieval endpoints ### List labs - [GET /partner/v2/account/{accountId}/location/{locationId}/lab](https://api-docs.lobbie.com/openapi/labs/listlabs.md): Retrieve lab orders and results for the location. Supports filtering by patient, status, vendor, and entry date range. ### Get lab by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/lab/{labId}](https://api-docs.lobbie.com/openapi/labs/getlab.md): Retrieve detailed information about a lab including all test components. ### List test components for lab - [GET /partner/v2/account/{accountId}/location/{locationId}/lab/{labId}/test-component](https://api-docs.lobbie.com/openapi/labs/listtestcomponents.md): Retrieve all test components (results) for the specified lab. ### Get test component by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/lab/{labId}/test-component/{componentId}](https://api-docs.lobbie.com/openapi/labs/gettestcomponent.md): Retrieve detailed information about a specific test component. ## Locations Location endpoints for scheduling flow ### List locations - [GET /partner/v2/account/{accountId}/location](https://api-docs.lobbie.com/openapi/locations/listlocations.md): Retrieve a paginated list of active locations for the account. Supports filtering by name and storeId. Use storeId filter to find a location by partner's external identifier. ### Get location by ID - [GET /partner/v2/account/{accountId}/location/{locationId}](https://api-docs.lobbie.com/openapi/locations/getlocation.md): Retrieve location information by location ID. The location must belong to the account associated with the OAuth token. ## Notification Groups Notification group retrieval endpoints ### List notification groups - [GET /partner/v2/account/{accountId}/notification-group](https://api-docs.lobbie.com/openapi/notification-groups/listnotificationgroups.md): Retrieve a paginated list of notification groups for the account. Each group ties together related notifications for an appointment, form, or payment. ### Get notification group by ID - [GET /partner/v2/account/{accountId}/notification-group/{groupId}](https://api-docs.lobbie.com/openapi/notification-groups/getnotificationgroup.md): Retrieve detailed information about a specific notification group. ## Notifications Notification retrieval endpoints ### List notifications - [GET /partner/v2/account/{accountId}/notification](https://api-docs.lobbie.com/openapi/notifications/listnotifications.md): Retrieve a paginated list of notifications for the account. Supports filtering by patient, notification group, type, status, and date range. Each notification tracks email and SMS delivery status independently. ### Get notification by ID - [GET /partner/v2/account/{accountId}/notification/{notificationId}](https://api-docs.lobbie.com/openapi/notifications/getnotification.md): Retrieve detailed information about a specific notification. ## Orders Purchase order retrieval endpoints ### List orders - [GET /partner/v2/account/{accountId}/location/{locationId}/order](https://api-docs.lobbie.com/openapi/orders/listorders.md): Retrieve purchase orders for the location using cursor pagination. Optional filters: status, patient ID, appointment ID. Results are ordered by creation time; use sortDir for ascending or descending order. ### Get order by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/order/{orderId}](https://api-docs.lobbie.com/openapi/orders/getorder.md): Retrieve a single purchase order for the location, including line items and subscriptions. ## Patients Patient category retrieval endpoints ### List patients - [GET /partner/v2/account/{accountId}/patient](https://api-docs.lobbie.com/openapi/patients/listpatients.md): Retrieve a paginated list of patients for the account. Supports filtering by name/email and cursor-based pagination. ### Create patient - [POST /partner/v2/account/{accountId}/patient](https://api-docs.lobbie.com/openapi/patients/createpatient.md): Create a new patient for the account. The account must match the OAuth token context. ### Get patient by ID - [GET /partner/v2/account/{accountId}/patient/{patientId}](https://api-docs.lobbie.com/openapi/patients/getpatient.md): Retrieve patient information by patient ID. The patient must belong to the authorized account. ### Update patient - [PUT /partner/v2/account/{accountId}/patient/{patientId}](https://api-docs.lobbie.com/openapi/patients/updatepatient.md): Update patient information by patient ID. Only provided fields will be updated. The patient must belong to the authorized account. ### List patient category assignments - [GET /partner/v2/account/{accountId}/patient/{patientId}/category](https://api-docs.lobbie.com/openapi/patients/listpatientcategories.md): Retrieve the patient's category assignments. By default returns all assignments; use the 'active' filter to narrow results. ### List patient category transitions - [GET /partner/v2/account/{accountId}/patient/{patientId}/category/transition](https://api-docs.lobbie.com/openapi/patients/listcategorytransitions.md): Retrieve the category transition history for the patient sorted by transitionedAt. ### Get category transition by ID - [GET /partner/v2/account/{accountId}/patient/{patientId}/category/transition/{transitionId}](https://api-docs.lobbie.com/openapi/patients/getcategorytransition.md): Retrieve detailed information about a specific category transition. ### List patient allergies - [GET /partner/v2/account/{accountId}/patient/{patientId}/health-profile/allergies](https://api-docs.lobbie.com/openapi/patients/listallergies.md): Retrieve all allergies for a patient including severity, reactions, and status. ### List patient medications - [GET /partner/v2/account/{accountId}/patient/{patientId}/health-profile/medications](https://api-docs.lobbie.com/openapi/patients/listmedications.md): Retrieve all medications for a patient including dosage instructions and status. ### List patient problems/diagnoses - [GET /partner/v2/account/{accountId}/patient/{patientId}/health-profile/problems](https://api-docs.lobbie.com/openapi/patients/listproblems.md): Retrieve all problems (diagnoses) for a patient including ICD-10 codes and status. ## Payment Attempts Payment attempt retrieval for a location ### List payment attempts - [GET /partner/v2/account/{accountId}/location/{locationId}/payment-attempt](https://api-docs.lobbie.com/openapi/payment-attempts/listpaymentattempts.md): Retrieve payment attempts for the location using cursor pagination. Optional filters: status, invoice ID, purchase order ID, patient ID, and createdOn bounds (startDate, endDate, ISO-8601 inclusive). ### Get payment attempt by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/payment-attempt/{paymentAttemptId}](https://api-docs.lobbie.com/openapi/payment-attempts/getpaymentattempt.md): Retrieve a single payment attempt for the location. ## Payments Payment retrieval for a location ### List payments - [GET /partner/v2/account/{accountId}/location/{locationId}/payments](https://api-docs.lobbie.com/openapi/payments/listpayments.md): Retrieve payments for the location using cursor pagination. Optional filters: posted-on date range (startDate, endDate on postedOn), invoice ID, purchase order ID, and patient ID. ### Get payment by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/payments/{paymentId}](https://api-docs.lobbie.com/openapi/payments/getpayment.md): Retrieve a single payment for the location. ## Refunds Refund retrieval for a location ### List refunds - [GET /partner/v2/account/{accountId}/location/{locationId}/refund](https://api-docs.lobbie.com/openapi/refunds/listrefunds.md): Retrieve refunds for the location using cursor pagination. Optional filters: posted-on date range (startDate, endDate on postedOn), patient ID, payment ID, and invoice ID. ### Get refund by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/refund/{refundId}](https://api-docs.lobbie.com/openapi/refunds/getrefund.md): Retrieve a single refund for the location. ## Rooms Room retrieval endpoints ### List rooms - [GET /partner/v2/account/{accountId}/location/{locationId}/room](https://api-docs.lobbie.com/openapi/rooms/listrooms.md): Retrieve rooms for the location. Supports filtering by active status. ### Get room by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/room/{roomId}](https://api-docs.lobbie.com/openapi/rooms/getroom.md): Retrieve information about a specific room. ## Self-Scheduling Self-scheduling configuration and availability endpoints ### Get appointment availability - [GET /partner/v2/account/{accountId}/self-scheduling/availability](https://api-docs.lobbie.com/openapi/self-scheduling/getavailability.md): Returns available appointment slots for a time range. Time range must not exceed 2 months (62 days). ### Get self-scheduling setting - [GET /partner/v2/account/{accountId}/self-scheduling/setting/{selfSchedulingSettingId}](https://api-docs.lobbie.com/openapi/self-scheduling/getsetting.md): Retrieve self-scheduling configuration with associated practitioners, locations, appointment types, and scheduler configs. ## Self-Scheduling Attempt Account-scoped self-scheduling attempt endpoints ### Create self-scheduling attempt - [POST /partner/v2/account/{accountId}/self-scheduling/attempt](https://api-docs.lobbie.com/openapi/self-scheduling-attempt/createattempt.md): Initialize a new self-scheduling attempt. Validates that the setting is active and, if provided, that the identity proof matches the setting's verification requirements. ### Get self-scheduling attempt - [GET /partner/v2/account/{accountId}/self-scheduling/attempt/{attemptId}](https://api-docs.lobbie.com/openapi/self-scheduling-attempt/getselfschedulingattempt.md): Retrieve details of an existing self-scheduling attempt by ID. Returns attempt status including identity proof verification status, patient ID (if set), and appointment ID (if created). Returns 404 if attempt doesn't exist or doesn't belong to this account. ### Create appointment for self-scheduling attempt - [POST /partner/v2/account/{accountId}/self-scheduling/attempt/{attemptId}/appointment](https://api-docs.lobbie.com/openapi/self-scheduling-attempt/createappointment_1.md): Creates an appointment for the specified self-scheduling attempt. Patient must be set on the attempt before creating an appointment. Scheduler config must belong to the self-scheduling setting. ### Attach a patient to a self-scheduling attempt - [POST /partner/v2/account/{accountId}/self-scheduling/attempt/{attemptId}/patient](https://api-docs.lobbie.com/openapi/self-scheduling-attempt/attachpatienttoselfschedulingattempt.md): Resolves or creates a patient from the provided demographics and attaches them to the self-scheduling attempt. If the attempt has a verified identity proof, patient resolution will use it for matching. Returns 200 if an existing patient was found, 201 if a new patient was created. ## Staff & Practitioners Staff member and practitioner retrieval endpoints ### List staff members - [GET /partner/v2/account/{accountId}/staff](https://api-docs.lobbie.com/openapi/staff-and-practitioners/liststaff.md): Retrieve a paginated list of staff members for the account. Supports filtering by location, status, and practitioner status. ### Get staff member by ID - [GET /partner/v2/account/{accountId}/staff/{staffId}](https://api-docs.lobbie.com/openapi/staff-and-practitioners/getstaff.md): Retrieve detailed information about a specific staff member. ## Subscriptions Subscription retrieval endpoints ### List subscriptions - [GET /partner/v2/account/{accountId}/location/{locationId}/subscription](https://api-docs.lobbie.com/openapi/subscriptions/listsubscriptions.md): Retrieve subscriptions for the location using cursor pagination. Optional filters: order ID, status, patient ID, item ID. ### Get subscription by ID - [GET /partner/v2/account/{accountId}/location/{locationId}/subscription/{subscriptionId}](https://api-docs.lobbie.com/openapi/subscriptions/getsubscription.md): Retrieve a single subscription for the location, including line items.