REST API

The NextStep REST API lets you programmatically interact with your process templates and running process instances. Use it to integrate NextStep with external tools like Zapier, Make, custom dashboards, or internal scripts.

Base URL

https://getnextstep.io/api/v1

If you use a custom subdomain, your API base URL is:

https://your-subdomain.getnextstep.io/api/v1

Quick Start

1. Create an API key from your dashboard
2. Make your first request:

curl -H "Authorization: Bearer nxs_live_your_key_here" \
  https://getnextstep.io/api/v1/process-templates

What You Can Do

Response Format

All responses use a consistent JSON format:

// Single resource
{
  "data": { "id": "abc", "title": "Onboarding", ... }
}
 
// List with pagination
{
  "data": [ ... ],
  "pagination": {
    "next_cursor": "abc123",
    "has_more": true
  }
}
 
// Error
{
  "error": {
    "code": "not_found",
    "message": "Process template not found"
  }
}

Rate Limiting

API requests are limited to 100 requests per minute per API key. If you exceed this limit, you’ll receive a 429 Too Many Requests response with a Retry-After header indicating how many seconds to wait.

Pagination

List endpoints return up to 20 items by default. Use limit and cursor query parameters to paginate:

# First page (5 items)
GET /api/v1/process-templates?limit=5
 
# Next page (use next_cursor from previous response)
GET /api/v1/process-templates?limit=5&cursor=abc123

Maximum limit is 100 items per page.