Skip to content

Get the caller

Identity module

GET/meme.get

Returns the calling person, their memberships and engagements, and the organization the credential is bound to. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability me.profile.write.
  • OAuth scopes: me.
  • Error statuses: 400, 401, 422, 429. Errors are RFC 9457 problem details.

Response 200: Me

me.get: Me
FieldTypeRequiredDescription
person_idstring (uuid)YesIdentifier of the calling person.
active_organization_idstring (uuid) | nullYesIdentifier of the organization the credential is bound to.
membership_countintegerYesInternal memberships held.Constraints: range 0 to any
engagement_countintegerYesExternal engagements held.Constraints: range 0 to any
{
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "active_organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "membership_count": 2,
  "engagement_count": 5
}

Code samples

curl -X GET "$XOS_BASE_URL/me" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.me.get();
response = xos.me.get()
xos me get