Skip to main content

​
Overview

The Folkyn API (/api/v1) is for server-side integrations. Each request uses a team API key; all data is scoped to that team. Rate limit: 60 requests/minute per key — see Rate limits.

​
Prerequisites

  • A team API key from Settings → Developer in the Folkyn app (see Authentication).

​
Base URL

Production: https://api.folkyn.com For local testing, use the base URL of the environment you control (for example http://localhost:3000).

​
OpenAPI specification

Download the contract without an API key:
FormatURL
OpenAPI 3 (YAML)GET https://api.folkyn.com/api/v1/openapi.yaml
OpenAPI 3 (JSON)GET https://api.folkyn.com/api/v1/openapi.json
The API Reference tab on this site is generated from the same OpenAPI documents. Import either URL into Postman (Import → Link), Insomnia (Import Data → From URL), or your codegen tool; prefer JSON if YAML import fails.

​
First request

List project codes with the Authorization header: 
curl -sS \
  -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.folkyn.com/api/v1/project-codes?page=1&per_page=10"
See Authentication if you need X-Api-Key instead of Bearer.

​
Success response

JSON responses wrap payloads in data: 
{
  "data": {
    "items": [],
    "page": 1,
    "per_page": 10,
    "total": 0
  }
}

​
Errors

On failure, the body includes an error object; error.code is always the same integer as the HTTP status. See Errors for the full shape and common cases.

​
Next steps

Use API Reference in the sidebar for every operation, schema, and generated cURL (and other) samples.

​
Product documentation

Broader Folkyn product help: doc.folkyn.com (linked from the app).