Skip to content

Who the caller is (SDD §3). Anonymous callers get signed_in false.

GET
/me
curl --request GET \
--url https://example.com/api/v1/me

The caller.

Media typeapplication/json
object
signed_in
required
boolean
mode
required
string
Allowed values: local hosted
user_id
string
email
string
role
string
Allowed values: admin member
maintainer

The caller maintains at least one profile.

boolean
guest
object
name
required
string
bundle_id
required
string format: uuid
Example
{
"mode": "local",
"role": "admin"
}

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example",
"code": "example"
}