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

# ProsperStack API Reference

This is the reference documentation for the ProsperStack API v1. Visit ProsperStack at [prosperstack.com](https://prosperstack.com). For more information on ProsperStack features, see the [primary documentation](https://prosperstack.com/docs/). Let us know how we can improve the API, documentation or anything else you need help with at [support@prosperstack.com](mailto:support@prosperstack.com). I. The API exposes 29 endpoints secured with basic authentication.

## For AI agents

Programmatically list events, retrieve an event. Covers 29 operations with basic authentication.

## Scope

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

## Capabilities

- List events
- Retrieve an event
- Create a customer portal session

## Use cases

### CRM Operations

Use the ProsperStack API Reference to perform crm operations programmatically. The API provides 29 endpoints covering core functionality including list events, retrieve an event, create a customer portal session.

Example prompt: Call GET /events to list events

### Automated flows Management

Automate flows operations by combining multiple ProsperStack API Reference endpoints. Agents can retrieve an event and then create a customer portal session in a single workflow.

Example prompt: Call GET `/events/{id}` to retrieve an event, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call ProsperStack API Reference 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 basic tokens manually.

Example prompt: Search Jentic for 'list events', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/events` | List events |
| GET | `/events/{id}` | Retrieve an event |
| POST | `/customer_portal/sessions` | Create a customer portal session |
| GET | `/flows` | List flows |
| GET | `/flows/{id}` | Retrieve a flow |
| GET | `/flow_sessions` | List flow sessions |
| GET | `/flow_sessions/{id}` | Retrieve a flow session |
| GET | `/offers` | List offers |

## Key resources

- **flows** — A flow represents a ProsperStack cancellation flow.
- **flow_sessions** — A flow session represents the session a cancelling subscriber took when going through the ProsperSta
- **offers** — An offer represents a [ProsperStack offer](https://docs.prosperstack.com/offers/creating-an-offer).
- **offer-links** — An offer link is a unique URL associating a landing page offer with a particular subscription. [Lear
- **payments** — A payment represents a retained payment made by a saved or deflected subscriber.

Payments can be of

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 37 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 44 / 100
  - Developer Experience & Jentic Compatibility: 67 / 100
  - AI-Readiness & Agent Experience: 46 / 100
  - Agent Usability: 94 / 100
  - Security: 10 / 100
  - AI Discoverability: 63 / 100
- **View full report:** https://jentic.com/apis/prosperstack.com/prosperstack/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the ProsperStack API by hand means encoding basic auth on every request and paging through events, flows, and offers yourself. Through Jentic you install once, import ProsperStack from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** ProsperStack puts the resource id in the URL path (`/flows/{id}`, `/events/{id}`, `/flow_sessions/{id}`), so a rule can pin your agent to reading a specific flow or event. You choose the operations it may call, so writes like creating a customer portal session are not included unless you add them.
- **Credential handling:** Your ProsperStack API credential 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 'list events' or 'read a cancellation flow', and Jentic returns the matching ProsperStack 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 ProsperStack API Reference use?

The ProsperStack API Reference uses HTTP Basic authentication with username and password. 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 list events with the ProsperStack API Reference?

Yes. Use the GET /events endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the ProsperStack API Reference?

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 list events through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'list events'. Jentic returns the matching ProsperStack API Reference operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the ProsperStack API Reference have?

The ProsperStack API Reference exposes 29 endpoints covering flows, flow_sessions, offers operations.

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

Yes. Because you run Jentic One yourself, you decide which ProsperStack operations your agent may call, so read-only endpoints like GET /events, GET /flows, and GET /flow_sessions can be allowed while a write such as creating a customer portal session stays off unless you add it. Since ProsperStack puts the resource id in the URL path, such as `/flows/{id}` or `/events/{id}`, your rules can pin the agent to reading one specific flow, event, or flow session. The stored credential is injected only when an operation you permitted runs.