Account

Whoami

Changed on

Return the caller's identity: organization, tier, key metadata, limits.

Works for every valid key. /account is an undocumented alias so both natural spellings resolve.

get/v1/me

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/me
  • Auth: HTTP bearer

Response

Successful Response

organization_idstring required

User-facing organization id (safe to log).

organization_namestring nullable

The organization's display name.

account_typestring required

Account tier (e.g. FREE, BUILD, SCALE).

user_emailstring nullable

Email of the user owning the API key.

rate_limitsobject

Effective per-minute rate limits by category (metadata/data/search/upload/compute) for this organization.

principal_scopedboolean

True when this key is end-user scoped (document ACL filtering applies to reads).

Example response

{
  "account_type": "BUILD",
  "key": {
    "key_type": "SECRET",
    "name": "backend-service",
    "permissions": [
      "READ",
      "WRITE"
    ]
  },
  "organization_id": "org_demo123",
  "organization_name": "Acme Corporation",
  "principal_scoped": false,
  "rate_limits": {
    "compute": 15,
    "data": 120,
    "metadata": 120,
    "search": 300,
    "upload": 30
  },
  "user_email": "alice@example.com"
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 23e05292e326Revision changes
    • info

      endpoint added