Skip to content
HeyX API

Me

Required scope: me:read

Generated Reference
POST /public-api/publicapi.v1.Workspace/Me

Returns the authenticated workspace and API key context.

Request MeRequest
Response MeResponse

MeRequest

No fields.

MeResponse

Field Type
workspace Workspace
api_key ApiKeyContext

Related Types

Workspace

Field Type
id string
name string
timezone string

ApiKeyContext

Field Type
id string
Terminal window
curl https://portal.heyx.app/public-api/publicapi.v1.Workspace/Me \
  -H "Authorization: Bearer hx_sk_..." \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "workspace": {
    "id": "8d4f6e86-7d82-4d6c-a9be-2d3d9a08f1d8",
    "name": "Acme Installers",
    "timezone": "Europe/Amsterdam"
  },
  "api_key": {
    "id": "5ba8a727-b605-4e5b-bd47-d2c23e5f8275"
  }
}
HeyX API