Skip to main content

​
Identifiers

Most API resources support two types of identifiers in path parameters:
TypeFormatExample
UUIDSystem-generated unique IDusr_a1b2c3d4
AliasUser-chosen globally unique namejanedoe
Either form can be used wherever a path parameter accepts a resource ID (e.g. {user_id}, {org_id}).

​
The “me” Alias

User endpoints accept the special value me as the {user_id} path parameter. It resolves to the authenticated user’s ID before any authorization checks are applied. 
# These are equivalent when authenticated as usr_a1b2c3d4
GET /v1/users/me
GET /v1/users/usr_a1b2c3d4
The me alias works with both bearer token and API key authentication.

​
Permissions

Access to user resources depends on whether the caller is the target user (self) or a different user (other).
EndpointSelfOther
GET /users/{user_id}Full profilePublic fields only
PATCH /users/{user_id}AllowedForbidden (403)
GET /users/{user_id}/orgsAll organizations (public + private)Public organizations only
GET /users/{user_id}/limitsAllowedForbidden (403)
See each endpoint’s documentation for details.