Skip to main content
KalinkloOS
Developer documentation

Developer portal

Quickstart

This request calls the public artists endpoint without a key. Its data object contains query, items and pagination.

Open OpenAPI JSONDownload OpenAPI JSON

Public sample read

Use your environment’s origin: https://kalinklo.com for production, or the assigned preview origin. Do not send a production key to a preview.

This public endpoint requires no API key. It lists eligible sample profiles, not private customer profiles. An empty list is valid and does not prove authenticated access.

bash
curl -sSf "https://kalinklo.com/api/v1/artists?limit=1" \
  -H "Accept: application/json"

Example with no matching sample profiles:

json
{
  "success": true,
  "data": {
    "query": {
      "page": 1,
      "limit": 1,
      "q": null,
      "artistType": null,
      "instrument": null,
      "country": null,
      "genre": null,
      "lastMinuteOnly": false,
      "verifiedOnly": false
    },
    "items": [],
    "pagination": {
      "page": 1,
      "limit": 1,
      "total": 0,
      "totalPages": 1,
      "hasNextPage": false,
      "hasPreviousPage": false
    }
  }
}

Organization read

Use an organization API key bound to your workspace with org:read:operations. Replace both placeholders; keep the real key on the server, never in browser code or source control.

bash
curl -sSf "https://kalinklo.com/api/org/v1/YOUR-WORKSPACE-SLUG/productions?limit=1" \
  -H "Authorization: Bearer abo_org_xxxxxxxx" \
  -H "Accept: application/json"

Example for an empty organization:

json
{
  "success": true,
  "data": {
    "items": [],
    "page": 1,
    "limit": 1,
    "total": 0,
    "totalPages": 1
  }
}

Validation and errors

These two routes return success: true with an endpoint-specific data object. Public artists use data.items and data.pagination; organization productions use data.items and pagination fields directly inside data. Do not assume a top-level count or nextCursor.

For the public request, limit=0 returns HTTP 422 with success: false and error.code set to VALIDATION_ERROR. Branch on error.code, not the human-readable error.message.

Mock console

The /developers console posts to /api/developers/sandbox, which returns fixed mock responses. It does not forward requests to the real API, authenticate a workspace key, or read customer records. Its sample format differs from the real responses above. Use the actual endpoint to verify your integration.

Next steps

Quickstart · Developer Docs | Kalinklo