API reference

REST API for the Getme platform — authentication, conventions, and resource endpoints.

The Getme API is a REST API over HTTPS. Requests and responses are JSON, resources are accessed through predictable URLs, and standard HTTP verbs and status codes are used throughout.

bash

curl https://api.getmeonline.io/v1/ping \
  -H "Authorization: Bearer $GETME_API_KEY"

Conventions

Introduction — base URLs, the response envelope, and how to read the reference.
Authentication — bearer tokens and auth modes.
Errors — status codes and error payloads.
Pagination — cursor-based list pagination.
Idempotent requests — safe retries with Idempotency-Key.
Versioning — date-based API versions.

Resources

The endpoint reference for each resource is generated from the public OpenAPI contract. Browse them in the sidebar under Core, Site, and Commerce resources.