Arketa

Describe a single report dataset: the filterable fields (with their type and valid operators), the date field that a startDate/endDate range is applied to, and the numeric (aggregate) and segment fields available for grouping. Use this before run_report to build valid filters.

describe_report

Look up a specific payment/charge by ONE identifier: a Stripe invoice id (`in_...`), an Arketa order id, or a payment id. Searches the studio's full payment history (all statuses) and returns the matching transaction rows PLUS the purchase the charge belongs to — including when that purchase lives on a linked FAMILY MEMBER's profile while billing this payer (a recurring charge with no matching purchase on the payer's own profile is usually this, not an orphaned charge). Human-facing invoice NUMBERS like `ABCD1234-0017` are not stored — provide the `in_...` invoice id instead, or find the charge via run_report (salesAll) by date and amount. Amounts are in the studio currency's main unit. Scoped to the authenticated studio.

find_payment

Get a single scheduled class by id (use get_schedule to find ids): time, instructor, location, capacity, spots remaining, waitlist length, description, booking flags and pricing option names. Scoped to the authenticated studio.

get_class

Get a single client's profile by id (use search_clients to find the id), for one client; for several ids use get_clients. Returns the client's key profile fields, including their current tags as { id, name } (the ids tag_clients takes). Scoped to the authenticated studio.

get_client

Get the family-account links around one client, in BOTH directions: `familyMembers` are the people linked under this client's account (this client is the account owner — a family member's subscription lives on the FAMILY MEMBER's profile, while the recurring charge usually bills the OWNER's payment method), and `memberOf` are the accounts that list this client as a family member (that owner is usually who pays for this client). ALWAYS check this when a client has a recurring charge with no matching purchase on their own profile — it is usually a family member's subscription, not an orphaned charge. Use search_clients/get_client to find the clientId. Scoped to the authenticated studio.

get_family_accounts

Get one client's purchases (packs, memberships/subscriptions, bundles, drop-ins) with offering name/type, price, credits remaining, subscription status and expiry. Use search_clients/get_client to find the clientId. Defaults to the full completed-purchase history (most recent first); pass activeOnly=true for only currently-usable purchases. `price` is in the studio currency's main unit (e.g. dollars, exactly as stored — a $150/month plan is price 150; never divide it). Also returns `familyMemberPurchases`: purchases on linked family members' profiles, which do NOT appear in this client's own list even though their recurring charges usually bill this client (the family-account owner) — check these before calling a charge orphaned. This is per-client history; for studio-wide sales totals use run_report (salesAll / salesSuccessful).

get_client_purchases

Get one client's reservations (booking history) — per booking: class name, start time, instructor, location, reservation type, check-in/attendance state, cancellation/late-cancel flags, waitlist position and whether it was paid. Use search_clients/get_client to find the clientId. This is per-client history; for studio-wide attendance use run_report (reservationsAll = bookings, classCheckIns = attendance). Most recent first; pass startDate/endDate to bound the range.

get_client_reservations

Get the forms a single client has filled out (waivers, intake forms, questionnaires) with their submitted answers and submission dates. Use search_clients/get_client to find the clientId. Returns one entry per submission across all of the studio's forms. For the blank form catalog (what forms exist) use list_forms; for every client's responses use list_form_responses.

get_client_forms

Profiles for up to 100 client ids in one call: use this after a report returns client ids, never get_client once per id. Returns a compact summary per client (name, email, phone, marketingOptIn, tags as { id, name }, created / last visit) plus smsReachable and emailReachable, which say whether a text or an email can reach that client. Ids that are deleted, removed, anonymous, a walk-in or unknown come back in missingIds. If the result is too large, droppedIds names the ids left out: call get_clients again with exactly those. Scoped to the authenticated studio.

get_clients

Get the studio's operating context: identity (name, timezone, currency), locations, instructors/staff, service categories, and client tags. Call this early — the instructor ids returned here are the ids used in report filters (instructor_id / instructor_ids_array) and in the schedule's instructorIds (host ids), the location ids match the report filter location_id, and the tag ids are what tag_clients takes (a tag the studio has not created is not listed and cannot be added). Scoped to the authenticated studio.

get_studio_context