Use Sparky from your own tools

Read your Sparky data from a script, a spreadsheet, your own website or an AI assistant. You sign in as yourself, and what you can see is exactly what you see in the app.

Three things first

1. 1. Your plan includes the API. API access is part of the Plus and Max plans. It is not available on Lite.
2. 2. Switch it on for your organization. An owner or admin opens SparkyLi, then Settings → API and agents, and presses Switch on. It stays off until someone does this. The same page shows which of your products have API access in your plan, and switching it off again stops all access at once.
3. 3. You see what your role sees. A tool signed in as you has your role. If you cannot open something in the app, the API will not show it either.

Then

• Sign inSign in as yourself from a terminal, script or agent and get a short-lived token.
• Your first callsWho you are, your organizations, your subscriptions and your first data.
• Errors and limitsEvery error code, what it means, the rate limit and paging.
• An app of your ownHow to get a scoped login for a website or script that runs on its own.
• AI agentsHow an AI assistant or agent uses the same sign-in and stays inside your plan.

The APIs

• PlatformWhere to start: who you are, your organizations, every product and what an organization subscribes to.Any plan
• Sparky ToursThe journeys an organization offers on its website, with their places, departures, booking terms and business profile.Plus and Max
• Sparky ContactsSearch and read the organization's contacts.Plus and Max
• Sparky ProjectsClients, projects, tasks and logged time.Plus and Max
• Sparky ExpensesRead expense claims.Plus and Max
• Sparky InvoicesRead invoices, clients and what has been paid.Plus and Max
• Sparky SignDocuments sent for signature and where each signer is. Sending, signing and voiding stay in the app.Plus and Max

Everything is read-only for now. Sending, paying, approving and deleting stay with a person in the app. Docs, Pay and Sign are not available yet. The directory is itself an API an agent can start from.