Client overview
client_overviewEverything about one or more clients (up to 10) in one call: profile and account balance, memberships, pricing options with sessions remaining, recent visits, upcoming bookings, and (on request) contracts and autopay. Mindbody calls: profiles and memberships take 1-2 calls for all clients together; services or contracts take 1 per client (and then include profile and memberships); visits and schedule take 1 per client each (at most 30). Ask only for the sections you need. Prefer this over reading visits, memberships, contracts or bookings one client and one endpoint at a time. To find which clients to look at, use find_client or clients_at_risk. A failed section is reported under "errors" without losing the rest.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| siteId | No | Site to call (SiteId header). Default -99. | |
| include | No | Sections to return besides the profile (default memberships, services, visits, schedule). Add "contracts" for contracts and autopay; it is slow because Mindbody sends each contract's full text. | |
| clientIds | Yes | Client IDs (the "id" from find_client), 1-10. | |
| visitsLimit | No | Recent visits per client (last 12 months, newest first), 1-50 (default 10). | |
| scheduleDays | No | Days ahead for upcoming bookings, 1-90 (default 30). |