# Account

The account and key behind the request.

Base URL: `https://vocenya.com/api/public/v1`. Authenticate with `Authorization: Bearer $VOCENYA_API_KEY`.

- [Get the current key](#get-me): `GET /me`

## Get the current key

`GET https://vocenya.com/api/public/v1/me`

Any valid API key.

Check a key and see which account it belongs to, what it may do and whether it is a live or a
test key. Needs no scope.

### Responses

- `200`
- `401`: The API key is missing, invalid, expired or revoked.
- `429`: Too many requests for this key. Wait for the `Retry-After` seconds.

### Response attributes (200)

- `data` (object, required)
  - `livemode` (boolean, required): `false` when the key is a test key (`vk_test_`): every request then reads and writes test data only.
  - `organization` (object, required)
    - `id` (integer, required)
    - `name` (string, required)
    - `hipaa_mode` (boolean, required): When true, transcripts, summaries, lead reasons and chat messages are never returned, and webhooks carry ids only.
    - `timezone` (string, required)
  - `api_key` (object, required)
    - `id` (integer, required)
    - `name` (string, required)
    - `prefix` (string, required)
    - `mode` (string, required): `live` or `test`. One of: `live`, `test`.
    - `scopes` (array of strings, required)
    - `expires_at` (string or null, required)

### Example request

```bash
curl https://vocenya.com/api/public/v1/me \
  -H "Authorization: Bearer $VOCENYA_API_KEY"
```

```javascript
const response = await fetch('https://vocenya.com/api/public/v1/me', {
  headers: {
    Authorization: `Bearer ${process.env.VOCENYA_API_KEY}`,
  },
});

const data = await response.json();
console.log(data);
```

```php
$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://vocenya.com/api/public/v1/me', [
    'headers' => ['Authorization' => 'Bearer '.getenv('VOCENYA_API_KEY')],
]);

$data = json_decode((string) $response->getBody(), true);
print_r($data);
```

```python
import os

import requests

response = requests.get(
    "https://vocenya.com/api/public/v1/me",
    headers={"Authorization": f"Bearer {os.environ['VOCENYA_API_KEY']}"},
)

print(response.json())
```

### Example response (200)

```json
{
  "data": {
    "livemode": true,
    "organization": {
      "id": 1,
      "name": "Rivera Plumbing",
      "hipaa_mode": true,
      "timezone": "America/Chicago"
    },
    "api_key": {
      "id": 1,
      "name": "Zapier",
      "prefix": "vk_live_a1b2c3d4",
      "mode": "live",
      "scopes": [
        "leads:read",
        "leads:write"
      ],
      "expires_at": "2026-10-02T14:03:11+00:00"
    }
  }
}
```