Skip to content
Hayonix

API reference · Account

The signed-in user, memberships, projects and pending invitations

GET/v1/me
Console session

For a signed-in user only (an API key learns its organization and project from GET /v1/caller). Each membership lists the permissions its role grants, for showing or hiding controls.

Console session only. The console calls this with a signed-in session; API keys are refused.

Request

Response

200 Me — You

  • objectstringrequired

    Always `me`: the type of this object

    One ofme

  • userobjectrequired

    The signed-in user

    Show 6 fields of user
    • idstringrequired

      Unique ID (`usr_…`)

      ID with prefix usr_

    • namestringrequired

      Its name

    • emailstringrequired

      Email address you sign in with

    • email_verifiedbooleanrequired

      Whether the email address has been confirmed; invitations are listed only once it has

    • imagestring | nullrequired

      Container image reference

    • created_atstring (date-time)required

      When it was created (ISO 8601, UTC)

  • membershipsarray of objectrequired

    Organizations you belong to, with your role in each

    Show 6 fields of memberships
    • member_idstringrequired

      ID of the member

      ID with prefix mem_

    • org_idstringrequired

      Organization it belongs to

      ID with prefix org_

    • org_namestringrequired

      Name of the organization

    • org_slugstringrequired

      Slug of the organization

    • roleRolerequired

      One ofowneradmindeveloperbillingviewer

    • permissionsarray of stringrequired

      Actions (`resource:verb`) this role grants in the org, for showing or hiding controls. The server authorises every request regardless.

  • projectsarray of Projectrequired

    Projects you can see across all your organizations

    Show 9 fields of projects
    • objectstringrequired

      Always `project`: the type of this object

      One ofproject

    • idstringrequired

      Unique ID (`prj_…`)

      ID with prefix prj_

    • org_idstringrequired

      Organization it belongs to

      ID with prefix org_

    • namestringrequired

      Its name

    • slugstringrequired

      Short URL-safe name, unique within the organization

    • descriptionstring | nullrequired

      Free-text description

    • archived_atstring (date-time) | nullrequired

      When it was archived (null while it is active) (ISO 8601, UTC)

    • created_atstring (date-time)required

      When it was created (ISO 8601, UTC)

    • updated_atstring (date-time)required

      When it last changed (ISO 8601, UTC)

  • invitationsarray of objectrequired

    Pending invitations to your email address (empty until the address is verified)

    Show 5 fields of invitations
    • idstringrequired

      Unique ID (`inv_…`)

      ID with prefix inv_

    • org_idstringrequired

      Organization it belongs to

      ID with prefix org_

    • org_namestringrequired

      Name of the inviting organization

    • rolestring | nullrequired

      Role you will have after accepting; null when none was set

      One ofowneradmindeveloperbillingviewer

    • expires_atstring (date-time)required

      When it expires (null: never) (ISO 8601, UTC)

Example response
Example response
{
  "object": "me",
  "user": {
    "id": "usr_01jc5zq4m8k3v6x9t2w7r0b1e4",
    "name": "string",
    "email": "string",
    "email_verified": true,
    "image": "string",
    "created_at": "2026-01-01T00:00:00.000Z"
  },
  "memberships": [
    {
      "member_id": "mem_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "org_name": "string",
      "org_slug": "string",
      "role": "owner",
      "permissions": [
        "org:read",
        "api_key:create"
      ]
    }
  ],
  "projects": [
    {
      "object": "project",
      "id": "prj_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "name": "string",
      "slug": "string",
      "description": "string",
      "archived_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "invitations": [
    {
      "id": "inv_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "org_id": "org_01jc5zq4m8k3v6x9t2w7r0b1e4",
      "org_name": "string",
      "role": "owner",
      "expires_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Errors

Errors use the standard envelope. What this operation can answer:

Errors
StatusTypeWhen
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.