API Reference

API Overview

Conventions used across every Gummble REST endpoint.

The Gummble REST API is hosted at https://api.gummble.com/api/v1. Everything below applies to every endpoint unless explicitly noted.

Base URL

https://api.gummble.com/api/v1

OAuth and well-known endpoints sit one level up (no /api/v1 prefix) so they comply with the RFCs that mandate fixed paths.

Authentication

Every request to /api/v1/* requires:

Authorization: Bearer <access_token>

Tokens come from Authentication.

Pagination

All collection endpoints use cursor-based pagination:

GET /apps?limit=20&cursor=eyJpZCI6...
{
  "data": [...],
  "pagination": {
    "cursor": "eyJpZCI6...",
    "hasMore": true,
    "total": 1247
  }
}

limit defaults to 20, max 100. Pass cursor from the previous response to advance.

Filtering

Most endpoints accept query-string filters. Repeat keys to OR-combine:

GET /apps?category=Finance&category=Travel&platform=ios

Response shape

Every successful response is { "data": ..., "pagination"?: ... }. Errors follow the JSON-Problem-ish shape:

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "App not found",
  "timestamp": "2026-05-23T16:00:00.000Z",
  "path": "/api/v1/apps/missing"
}

See Errors for the full catalogue.

Versioning

The path segment (/v1) pins the major version. Breaking changes will publish at /v2 and run in parallel for at least 6 months.

Endpoints