Reference · Account

Your user

Returns the user who owns the key and details of the key used in the request. Use it to test whether the key works.

Parameters

This endpoint takes no parameters.

Response fields

uid string

User identifier.

name string

User's name.

email string

User's email address.

language string

User's control panel language, in the pt_BR format.

api_key object

Key used in this request.

api_key.name string

Name given to the key when it was generated.

api_key.prefix string

Beginning of the key, the same one shown in the control panel. The full key is never shown again.

api_key.created_at string

When the key was generated.

api_key.last_used_at string | null

Last recorded use of the key, updated at most every 5 minutes, or null.

Possible errors

• Key and rate limit errors apply to every endpoint. See all errors

curl "https://api.on-cloud.live/v1/me" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/me');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/me', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

{
  "data": {
    "uid": "3c59dc048e8850243be8079a5c74d079",
    "name": "Mariana Souza",
    "email": "mariana@exemplo.com.br",
    "language": "pt_BR",
    "api_key": {
      "name": "Monitoramento",
      "prefix": "apk_527d541b",
      "created_at": "2026-11-01T09:15:42-03:00",
      "last_used_at": "2026-11-03T14:31:58-03:00"
    }
  }
}