API reference · Account
The signed-in user, memberships, projects and pending invitations
/v1/meFor 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
objectstringrequiredAlways `me`: the type of this object
One of
meuserobjectrequiredThe signed-in user
ShowHide 6 fields of
useridstringrequiredUnique ID (`usr_…`)
ID with prefix usr_
namestringrequiredIts name
emailstringrequiredEmail address you sign in with
email_verifiedbooleanrequiredWhether the email address has been confirmed; invitations are listed only once it has
imagestring | nullrequiredContainer image reference
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
membershipsarray of objectrequiredOrganizations you belong to, with your role in each
ShowHide 6 fields of
membershipsmember_idstringrequiredID of the member
ID with prefix mem_
org_idstringrequiredOrganization it belongs to
ID with prefix org_
org_namestringrequiredName of the organization
org_slugstringrequiredSlug of the organization
One of
owneradmindeveloperbillingviewerpermissionsarray of stringrequiredActions (`resource:verb`) this role grants in the org, for showing or hiding controls. The server authorises every request regardless.
Projects you can see across all your organizations
ShowHide 9 fields of
projectsobjectstringrequiredAlways `project`: the type of this object
One of
projectidstringrequiredUnique ID (`prj_…`)
ID with prefix prj_
org_idstringrequiredOrganization it belongs to
ID with prefix org_
namestringrequiredIts name
slugstringrequiredShort URL-safe name, unique within the organization
descriptionstring | nullrequiredFree-text description
archived_atstring (date-time) | nullrequiredWhen it was archived (null while it is active) (ISO 8601, UTC)
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
updated_atstring (date-time)requiredWhen it last changed (ISO 8601, UTC)
invitationsarray of objectrequiredPending invitations to your email address (empty until the address is verified)
ShowHide 5 fields of
invitationsidstringrequiredUnique ID (`inv_…`)
ID with prefix inv_
org_idstringrequiredOrganization it belongs to
ID with prefix org_
org_namestringrequiredName of the inviting organization
rolestring | nullrequiredRole you will have after accepting; null when none was set
One of
owneradmindeveloperbillingviewerexpires_atstring (date-time)requiredWhen it expires (null: never) (ISO 8601, UTC)
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:
| Status | Type | When |
|---|---|---|
401 | authentication_error | The key or session is missing, revoked or expired. |
403 | permission_error | The credential lacks the permission this needs, or the organization is suspended. |
429 | rate_limit_error rate_limited | Too many requests; retry after retry-after seconds. |