Get current user

Designed for MCP and AI agent clients that need to resolve “me”, “my”, or “I” into concrete UUIDs before calling other endpoints (e.g. fetching activity history or relationship data for the current user).

Returns null fields when the API key is tenant-scoped with no user context.

GET /v1/me

Return the identity of the currently authenticated user.

cURL

curl --request GET \
  --url https://production-api.joinrings.com/v1/me \
  --header 'x-api-key: <api-key>'

import requests

url = "https://production-api.joinrings.com/v1/me"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://production-api.joinrings.com/v1/me', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://production-api.joinrings.com/v1/me",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://production-api.joinrings.com/v1/me"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://production-api.joinrings.com/v1/me")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production-api.joinrings.com/v1/me")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "company_uuid": "<string>",
  "email": "<string>",
  "name": "<string>",
  "person_uuid": "<string>",
  "tenant_key": "<string>",
  "tenant_uuid": "<string>",
  "user_uuid": "<string>"
}

Authorizations

x-api-key · string · header · required

Response

200 - application/json

Identity of the API key's authenticated user.

Use the returned UUIDs when calling other endpoints that require explicit identity parameters (e.g. person_uuid for activity history). Returns null fields when the key is tenant-scoped with no user context.

company_uuid · string | null · required

email · string | null · required

name · string | null · required

person_uuid · string | null · required

tenant_key · string | null · required

tenant_uuid · string | null · required

user_uuid · string | null · required