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.

2. Set the base URL

All requests go to:

https://production-api.joinrings.com

3. Authenticate

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:

{
  "user_uuid": "3f1c...",
  "person_uuid": "9ab2...",
  "company_uuid": "5d4e...",
  "email": "you@example.com",
  "name": "Your Name",
  "tenant_key": "your-tenant",
  "tenant_uuid": "7c60..."
}

4. List some persons

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

5. Look up a person by email

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

Next steps

Full API Reference

Every endpoint, request, and response schema.

Connect via MCP

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

Concepts

Rings, PathPower, opportunities — the vocabulary in plain language.

Getting Started

MCP Guide

1. Get an API key

2. Set the base URL

3. Authenticate

4. List some persons

5. Look up a person by email

Next steps

Full API Reference

Connect via MCP

Concepts

​1. Get an API key

​2. Set the base URL

​3. Authenticate

​4. List some persons

​5. Look up a person by email

​Next steps

Full API Reference

Connect via MCP

Concepts

1. Get an API key

2. Set the base URL

3. Authenticate

4. List some persons

5. Look up a person by email

Next steps