Arboxapp Arbox API

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.