Quickstart

1. Get an API key

Sign in to Rings and generate an API key from your workspace settings. Treat this key like a password — never commit it to source control.

All requests go to:

https://production-api.joinrings.com

Pass your API key in the x-api-key header on every request:

curl https://production-api.joinrings.com/v1/me \
  -H "x-api-key: $RINGS_API_KEY"

A successful response returns the authenticated user:

{
  "uuid": "....",
  "email": "you@example.com",
  "name": "Your Name"
}

curl "https://production-api.joinrings.com/v1/persons?limit=10" \
  -H "x-api-key: $RINGS_API_KEY"

curl "https://production-api.joinrings.com/v1/persons/lookup?email=someone@example.com" \
  -H "x-api-key: $RINGS_API_KEY"

Every endpoint, request, and response schema.

Give Claude, Cursor, and other AI tools access to Rings.

⌘I