Skip to main content

​
Machine-readable spec

Download the contract without an API key:
FormatURL
YAMLGET https://api.folkyn.com/api/v1/openapi.yaml
JSONGET https://api.folkyn.com/api/v1/openapi.json
Import the JSON or YAML URL into Insomnia, Postman, or your codegen tool to stay in sync with production. Use the API Reference tab for endpoints; the Guides tab has quickstart, authentication, errors, and rate limits. In the sidebar, each section (Overview, Specification, Project codes, Team tags, Missions, Activity reports) is a top-level group: the section title and its endpoint list stay visible without opening a parent dropdown. Under each section, entries follow METHOD + short title (for example GET List project codes), matching the OpenAPI document.

​
Try requests

Some endpoint pages include Mintlify’s interactive Try it / playground (OpenAPI). When you use it:
  1. Base URL — Send requests to https://api.folkyn.com unless you intentionally target another environment (for example a local Next.js dev server).
  2. Team API key — Use one auth method only (not both on the same request):
    • Authorization: Bearer — Paste the full key including the fk_live_ prefix. If the UI has a separate Bearer or token field, put the key there and let the tool add the Bearer prefix; avoid ending up with Bearer Bearer ….
    • X-Api-Key — Set this header to the same full key value (no Bearer prefix).
  3. Complete path parameters, query fields, and JSON body as the operation requires, then run the request.
See Authentication for key handling and 401 behavior. Rate limits apply (60 requests/minute per key).