---
title: "Retrieve me"
method: GET
path: "/me"
tags: ["Core resources"]
---

# Retrieve me

`GET /me`

## Request

- Base URL: `https://core.sivo.com`
- URL: `https://core.sivo.com/me`
- Auth: one of:
  - API key in header `Authorization`
  - OAuth 2
    - Authorization code: `https://dashboard.sivo.com/oauth/authorize`
    - Client credentials
    - Token URL: `https://core.sivo.com/oauth/token`
- TypeScript: <https://skmtc.dev/sivo/apis/sivo-advance-api/docs/me/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

Successful operation

- object
  - `given_name` string: Non-empty text string
  - `family_name` string: Non-empty text string
  - `picture` string, uri: HTTP(S) URL
  - `name` string: Non-empty text string
  - `zoneinfo` string: IANA timezone identifier
  - `locale` string: BCP 47 locale
  - `address` object: An address as described in the OpenID connect specification for address defined in Section 5.1.1. https://openid.net/specs/openid-connect-core-1_0.html#AddressClaim
    - `region` string: State, province, prefecture, or region component. For the US and Canada, MUST be 2-letter abbreviation.
    - `country` string, required: ISO 3166-1 alpha-2 country code
    - `formatted` string: Full mailing address, formatted for display or use on a mailing label. This field MAY contain multiple lines, separated by newlines.
    - `street_address` string: Full street address component, which MAY include house number, street name, Post Office Box, and multi-line extended street address information. This field MAY contain multiple lines, separated by newlines.
    - `locality` string: City, town, or locality component.
    - `postal_code` string: Zip code or postal code component.
  - `email` string, email: An email address
  - `phone_number` string: E.164 phone number
  - `email_verified` boolean: A boolean value
  - `phone_number_verified` boolean: A boolean value
  - `enabled` boolean, required: A boolean value
  - `id` string, required: An object id with prefix
  - `created_at` string, date-time, required: Creation date and time
  - `created_by` string, required: ID of the user that created this object
  - `updated_at` string, date-time, required: Last update date and time
  - `updated_by` string, required: ID of the user that last updated this object

## Changes

- **2026-11-03** `4bbab9699612`: 2 info
  - the `created_by` response's property pattern was changed from `^[a-z]{3,7}_[0-9A-Za-z]{27}$` to `^[0-9A-Za-z_-]{1,255}$` for the status `200`
  - the `updated_by` response's property pattern was changed from `^[a-z]{3,7}_[0-9A-Za-z]{27}$` to `^[0-9A-Za-z_-]{1,255}$` for the status `200`

[Operation history](https://skmtc.dev/sivo/apis/sivo-advance-api/changes/me/get.md)

---

[API](https://skmtc.dev/sivo/apis/sivo-advance-api.md) - [All operations](https://skmtc.dev/sivo/apis/sivo-advance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sivo/apis/sivo-advance-api/revisions/4bbab9699612?raw)