canonical: https://jentic.com/apis/spektrix.com/spektrix

# Spektrix API

Spektrix is the market-leading CRM, ticketing, marketing and fundraising solution for theatres and the performing arts. This API provides access to events, customers, baskets, orders, and related resources. The API exposes 201 endpoints secured with apiKey authentication.

## For AI agents

Programmatically returns the full address for a given id, returns a list of addresses matching a given postcode. (uk addresses only). Covers 201 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or developer tools - use for crm only.

## Capabilities

- Returns the full address for a given ID
- Allows an agent to determine how much of their credit limit has been used, and h
- Clears the contents of the current basket
- Return the current contents of the Basket
- To add additional information to the basket, such as a Customer, Promocode, Attr

## Use cases

### CRM Operations

Use the Spektrix API to perform crm operations programmatically. The API provides 201 endpoints covering core functionality including returns the full address for a given id, returns a list of addresses matching a given postcode. (uk addresses only), allows an agent to determine how much of their credit limit has been used, and h.

Example prompt: Call GET `/v3/addresses/{postcodeLookupId}` to returns the full address for a given id

### Automated Addresses Management

Automate addresses operations by combining multiple Spektrix API endpoints. Agents can returns a list of addresses matching a given postcode. (uk addresses only) and then allows an agent to determine how much of their credit limit has been used, and h in a single workflow.

Example prompt: Call GET `/v3/addresses` to returns a list of addresses matching a given postcode. (uk addresses only), then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Spektrix API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'returns the full address for a given id', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v3/addresses/{postcodeLookupId}` | Returns the full address for a given ID |
| GET | `/v3/addresses` | Returns a list of addresses matching a given postcode. (UK Addresses only) |
| GET | `/v3/credit` | Allows an agent to determine how much of their credit limit has been used, and h |
| GET | `/v3/bands` | Returns a list of price bands in the system |
| POST | `/v3/basket/clear` | Clears the contents of the current basket |
| GET | `/v3/basket` | Return the current contents of the Basket |
| PATCH | `/v3/basket` | To add additional information to the basket, such as a Customer, Promocode, Attr |
| POST | `/v3/basket/confirm` | Confirms an order. This can only be used for zero-value orders. |

## Key resources

- **Addresses** — Addresses operations
- **AgentCredit** — AgentCredit operations
- **Bands** — Bands operations
- **Basket** — Basket operations
- **Baskets** — Baskets operations

## Why Jentic

- **Setup:** Wiring the Spektrix API by hand means sending your key in the Authorization header, substituting your clientName into the host template, and routing across its large basket, address, and ticketing surface yourself. Through Jentic you install once, import the Spektrix API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Spektrix puts resource ids in the URL path (`/v3/basket/donations/{donationId}`, `/v3/addresses/{postcodeLookupId}`), so a rule can pin your agent to one basket item: it reads and amends that item and nothing else. You choose the operations it may call, so destructive ones like clearing the basket or deleting a donation are not included unless you add them.
- **Credential handling:** Your Spektrix API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'look up an address by id' or 'add tickets to a basket', and Jentic returns the matching Spektrix operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Spektrix API use?

The Spektrix API uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I returns the full address for a given id with the Spektrix API?

Yes. Use the GET `/v3/addresses/{postcodeLookupId}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Spektrix API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I returns the full address for a given id through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'returns the full address for a given id'. Jentic returns the matching Spektrix API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Spektrix API have?

The Spektrix API exposes 201 endpoints covering addresses, agentcredit, bands operations.

### Can I limit what my agent is allowed to do with the Spektrix API?

Yes. Because you run Jentic One yourself, you decide which Spektrix operations your agent may call, so read-only calls like GET `/v3/addresses/{postcodeLookupId}` or GET `/v3/basket` can be permitted while destructive ones such as POST `/v3/basket/clear` or deleting a donation stay out unless you explicitly add them. Since Spektrix carries resource IDs in the URL path, like `/v3/basket/donations/{donationId}` and `/v3/addresses/{postcodeLookupId}`, your own rules can pin the agent to a single basket item so it reads and amends that item and nothing else. Your API key is stored encrypted by your own instance and injected at execution time, so the agent never sees the raw credential.