Skip to content

API Reference

Everything you can do in the GatherCloud dashboard is also available over a REST API, so you can create events, drive their lifecycle, and pull recordings and transcripts from your own systems.

Base URL

https://api.gathercloud.dev

All endpoints are versioned under /v1.

Authentication

Server-to-server calls authenticate with a workspace API key in the x-api-key header. See Authentication.

sh
curl https://api.gathercloud.dev/v1/events \
  -H "x-api-key: gck_..."

Conventions

  • Requests and responses are JSON (content-type: application/json).
  • Timestamps are ISO 8601 strings (2026-06-11T18:00:00.000Z).
  • IDs are UUIDs.
  • Successful deletes return 204 No Content.

Errors

Errors use a problem+json style body with a stable code:

json
{
  "type": "https://gathercloud.dev/errors/not_found",
  "code": "not_found",
  "detail": "event not found"
}
StatusCodeMeaning
400bad_requestMalformed or missing input
401unauthorizedMissing or invalid credentials
403forbiddenAuthenticated, but not allowed
404not_foundNo such resource in your workspace
409conflict (e.g. slug_taken)State conflict

Resources