canonical: https://jentic.com/apis/arboxapp.com/arboxapp # Arboxapp Arbox API Jentic publishes the only available OpenAPI specification for Arbox API, keeping it validated and agent-ready. Arbox is a gym and fitness studio management platform used by boutique studios, CrossFit boxes, and franchise chains to run day-to-day operations. The API exposes 39 endpoints covering leads, clients, memberships, schedules, tasks, reports, messaging, and locations. Authentication is via an API key provided by the studio's Arbox admin. ## For AI agents Manage gym leads, clients, memberships, class schedules, tasks, and messaging for an Arbox-powered fitness studio. ## Scope Does not handle payment processing, email marketing automation, or wearable device sync - use for gym lead, client, membership, and schedule management only. ## Capabilities - Capture new gym leads from a website form into the Arbox CRM - Move a lead through statuses including converted and lost - Search for an existing client or lead before creating a duplicate - Pull membership records to confirm a client's plan and expiry - Read class and session schedules across studio locations - Create and update operational tasks for studio staff - Send messages to clients and read studio reports ## Use cases ### Lead Capture from Website to Arbox Push new prospects from a studio's marketing website or landing page directly into the Arbox CRM so trainers can follow up. Boutique gyms and franchise studios use this to avoid manual data entry between Mailchimp-style funnels and their day-to-day software. POST /leads accepts the prospect's contact details and assigns them an Arbox lead record. Example prompt: Call POST /leads with the prospect's name, email, phone, and source, then return the Arbox lead ID for downstream follow-up. ### Membership Lookup at the Front Desk When a client checks in, look up their membership status to confirm whether their plan covers today's class. Studio front-desk software uses this to gate access without manual intervention. The clients and memberships endpoints return the active plan, expiry date, and remaining session count. Example prompt: Search for the client by email via GET /searchUser, then fetch their membership record and confirm whether the plan is active today. ### Schedule Display for Mobile App Pull the class and session schedule for a studio location into a member-facing app. Multi-location chains use this to show consistent, up-to-date class times without storing duplicate schedule data in a second system. The schedule endpoints return classes per location with start time, capacity, and instructor. Example prompt: Call the schedule endpoint for the requested location and date, then return the list of classes with start time, instructor, and remaining spots. ### Lead Funnel Reporting Aggregate Arbox leads, converted leads, and lost leads to produce a weekly funnel view for studio owners. Multi-site chains use this to compare conversion rates across locations and lead sources. The leads, convertedLeads, and lostLeads endpoints supply the raw data. Example prompt: Pull GET /leads, GET /convertedLeads, and GET /lostLeads for the last 30 days, then compute the conversion rate per lead source. ### AI Agent Studio Assistant via Jentic A studio-front assistant agent helping trainers run their day can call Arbox through Jentic to answer questions like 'is this client's membership active' or 'create a follow-up task for this lead'. The agent searches for the right operation, loads the schema, and executes without managing the API key. Jentic resolves credentials from its vault. Example prompt: Use Jentic search 'create a new gym lead in Arbox', load the schema for POST /leads, then execute with the prospect details and return the new lead ID. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /leads | List in-progress leads | | POST | /leads | Create a new lead | | GET | /convertedLeads | List converted leads | | GET | /lostLeads | List lost leads | | GET | /searchUser | Search for a user or lead | | POST | /updateLeadStatus | Update a lead's status | ## Key resources - **Leads** — Capture, search, and update prospect leads through statuses including converted and lost - **Clients** — Search and manage existing client records and contact information - **Memberships** — Read membership plans and remaining session counts for clients - **Schedule** — Read class and session schedules across studio locations - **Tasks** — Create and update operational tasks for studio staff - **Messages** — Send messages to clients via the Arbox messaging channels - **Reports** — Pull operational and lead-source reports for studio owners ## Why Jentic - **Setup:** Wiring Arbox by hand means learning its accesstoken header scheme and mapping its lead, client, membership, and schedule endpoints yourself. Through Jentic you install once, import the Arbox API from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** Arbox takes its lead and user targets in the request body rather than the URL path, so you limit the agent to the operations it needs, such as reading leads or searching users. You choose the operations it may call, so writes like creating a lead or updating a lead status are not included unless you add them. - **Credential handling:** Your Arbox API key is stored once, encrypted, by your own Jentic One instance and injected as the accesstoken header at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a new gym lead in Arbox', and Jentic returns the matching Arbox operation with its input schema so the agent calls the right endpoint without browsing docs. ## Related APIs - **Stripe API** — Take membership payments via Stripe, then sync the resulting customer back to Arbox as the studio's source of truth for clients. - **Mailchimp Marketing API** — Pair Arbox leads with Mailchimp for nurture email sequences before conversion. - **Shopify Admin API** — Studios that primarily sell merchandise and class packs may pick Shopify; Arbox is purpose-built for fitness operations. ## FAQ ### Why is there no official OpenAPI spec for Arbox API? Arbox does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Arbox API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Arbox API use? Arbox uses an API key passed in an accesstoken header. The key is provisioned by the studio's Arbox admin. Through Jentic, the key is stored encrypted in the vault and injected at request time so it never enters the agent's context. ### Can I push leads from a marketing form into Arbox? Yes. POST /leads accepts the prospect's contact fields and source, returning the new lead ID. Use POST /updateLeadStatus to move the lead through statuses as it progresses to converted or lost. ### How do I look up a client's membership at check-in? Call GET /searchUser with the client's identifier or email to confirm the record, then read the client's membership data from the corresponding membership endpoints. The response includes plan name, expiry, and remaining sessions. ### What are the rate limits for the Arbox API? The OpenAPI spec does not declare explicit rate limits. Arbox enforces tenant-level fair-use throttling that varies by plan; sustained high-frequency polling may be rate-limited. Check with your Arbox account manager for the limits applied to your studio. ### How do I create a new lead through Jentic? Install Jentic with pip install jentic, search for 'create a new gym lead in Arbox', load the schema for POST /leads, then execute with the prospect's name, email, and source. Jentic injects the API key automatically. ### Can I limit what my agent is allowed to do with the Arbox API? Yes. Because you run Jentic One yourself, your own rules decide which Arbox operations and credentials the agent may use. Since Arbox takes its lead and user targets in the request body rather than the URL path, you can restrict the agent to only the operations it needs, such as reading leads with GET /leads or looking up a client with GET /searchUser. Write operations like creating a lead with POST /leads or changing a status with POST /updateLeadStatus stay excluded unless you explicitly add them.