Nuvelics documentation
APIAPI reference

Your account

Read your own user and organization, update your profile, or deactivate your account.

GET
/api/tenant/v1/me

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Response Body

The calling principal's user (null for service keys) and organization

application/json
  1. response
user*

The calling user, or null for service keys

organization*
Example Request
curl -X GET 'https://api.nuvelics.com/api/tenant/v1/me'
Example Response
{  "user": {    "id": "string",    "email": "user@example.com",    "emailVerified": true,    "name": "string",    "locale": "string",    "status": "active",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "version": 0  },  "organization": {    "id": "string",    "name": "string",    "slug": "string",    "status": "active",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "version": 0,    "editorialGuidelines": "string",    "mcpEnabled": false,    "mcpBlockSelfRegisteredClients": true  }}
PATCH
/api/tenant/v1/me

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Request Body

application/json
  1. body
name?string

User display name

Length1 <= length
locale?string

User's preferred UI locale (BCP 47 language tag)

Length2 <= length

Response Body

Profile updated

application/json
  1. response
id*string

User identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
email*string

User email address

Formatemail
emailVerified*boolean

Whether the email address has been verified

name?string

User display name

locale*string

User's preferred UI locale (BCP 47 language tag), e.g. "en"

status*string

User lifecycle status; deactivated is a soft-delete tombstone

Value in"active""deactivated"
createdAt*string

ISO 8601 creation timestamp

Formatdate-time
updatedAt*string

ISO 8601 last-modified timestamp

Formatdate-time
version*integer

Monotonic row version; used as concurrency token

Example Request
curl -X PATCH 'https://api.nuvelics.com/api/tenant/v1/me' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "email": "user@example.com",  "emailVerified": true,  "name": "string",  "locale": "string",  "status": "active",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0}
POST
/api/tenant/v1/me/deactivate

Authorization

headerx-api-key<token>

A service key (nvs_...) in the x-api-key header. A service key belongs to one organization: an X-Org-Id header is optional and, when sent, must name that organization. This header also accepts any credential the bearer scheme does, and when a request sends both headers, this one is used.

Response Body

Account deactivated; returns the anonymized user record

application/json
  1. response
id*string

User identifier

Match^[0-7][0-9A-HJKMNP-TV-Z]{25}$
email*string

User email address

Formatemail
emailVerified*boolean

Whether the email address has been verified

name?string

User display name

locale*string

User's preferred UI locale (BCP 47 language tag), e.g. "en"

status*string

User lifecycle status; deactivated is a soft-delete tombstone

Value in"active""deactivated"
createdAt*string

ISO 8601 creation timestamp

Formatdate-time
updatedAt*string

ISO 8601 last-modified timestamp

Formatdate-time
version*integer

Monotonic row version; used as concurrency token

Example Request
curl -X POST 'https://api.nuvelics.com/api/tenant/v1/me/deactivate'
Example Response
{  "id": "string",  "email": "user@example.com",  "emailVerified": true,  "name": "string",  "locale": "string",  "status": "active",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "version": 0}

Report a problem with this page

On this page