Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: ProsperStack API Reference Flows API
version: v1
description: 'This is the reference documentation for the ProsperStack API v1. Visit ProsperStack at prosperstack.com.
For more information on ProsperStack features, see the primary documentation.
Let us know how we can improve the API, documentation or anything else you need help with at support@prosperstack.com.
# Introduction
The ProsperStack API provides a REST-like interface to your ProsperStack data. It uses standard HTTP verbs, accepts JSON-encoded request bodies and provides JSON-encoded responses.
You can use the ProsperStack API to access your live production data or data from test mode. The API key you use to authenticate requests determines which mode will be used.
# Authentication
The ProsperStack API uses API keys to authenticate requests. You can manage your API keys from the ProsperStack API Keys settings page.
Live mode API keys have the prefix `key_` and test mode API keys have the prefix `key_test_`.
Authentication uses HTTP basic authentication. Provide your API key as the basic authentication username. You don''t need to provide a password.
A simple example using cURL:
```bash
curl https://api.prosperstack.com/v1/flow_sessions \
-u key_LSdJXBrN3SP7bdJrQSMp2eZK:
```
Learn more about creating API keys.
# Pagination
All list endpoints support cursor-based pagination. The body of a list response will contain a `data` property with an array of objects and a `next_cursor` property desginating the cursor value to retrieve the next set of results.
Use the value of `next_cursor` in the `cursor` query parameter to specify the set of results to return. If `next_cursor` is `null`, there are no more results.
You can also specify a `limit` in the query parameters to adjust the number of items per result set. The limit defaults to 10 and has a maximum of 100.
# Rate limits
The ProsperStack API enforces a rate limit of 100 requests per minute. Your live mode and test mode accounts have separate limits.
When the rate limit is exceeded, requests will fail with the HTTP status `429 Too Many Requests` until the limit window resets.
The ProsperStack API implements the RateLimit Header Fields for HTTP draft which describes a set of HTTP headers you can use to observe current request limits.
The headers are:
- `RateLimit-Limit` — The limit of requests per time window (1 minute)
- `RateLimit-Remaining` — The number of requests left before exceeding the limit
- `RateLimit-Reset` — The number of seconds until the limit window resets
If you need to exceed the rate limit, let us know at support@prosperstack.com and we''ll be happy to help.'
x-logo:
url: https://prosperstack.com/images/logo-api.svg
servers:
- url: https://api.prosperstack.com/v1
security:
- basicAuth: []
tags:
- name: Flows
x-displayName: Flows
description: A flow represents a ProsperStack cancellation flow.
paths:
/flows:
get:
summary: List flows
operationId: listFlows
tags:
- Flows
parameters:
- name: cursor
in: query
description: Pagnination cursor to retrieve
schema:
type: string
- name: limit
in: query
description: Limit of flows to return
schema:
type: integer
minimum: 1
maximum: 100
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/Flow'
next_cursor:
$ref: '#/components/schemas/Cursor'
'401':
description: Unauthorized
$ref: '#/components/responses/Error'
/flows/{id}:
get:
summary: Retrieve a flow
operationId: retrieveFlowById
tags:
- Flows
parameters:
- name: id
in: path
description: Flow ID to retrieve
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Flow'
'401':
description: Unauthorized
$ref: '#/components/responses/Error'
'404':
description: Not Found
$ref: '#/components/responses/Error'
components:
responses:
Error:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
schemas:
Error:
type: object
required:
- error
properties:
error:
type: string
Flow:
type: object
required:
- id
- name
- created_at
- updated_at
properties:
id:
type: string
example: flow_3Aree3otQWV2qXhFiehIIQpA
name:
type: string
example: Default
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
Cursor:
type:
- string
- 'null'
example: 'null'
securitySchemes:
basicAuth:
type: http
scheme: basic