Users
The User API exposes user records — distinct from the Me API which is scoped to the authenticated caller.
You read user records here when you need information about other users your token can see (typically other members of organizations or groups you share).
Endpoints at a glance
Section titled “Endpoints at a glance”| Endpoint | What it returns |
|---|---|
GET /v1/public/entities/{slug} |
A user’s (or organization’s) public profile |
GET /v1/directory/entities?query=…&entity_type=user |
Search the directory of users and organizations (paginated) |
PATCH /v1/users/{slug} |
Update your own profile |
GET/POST /v1/users/{slug}/observations |
Observations owned by the user; create one owned by the user |
GET/POST /v1/users/{slug}/observing-accounts |
Observing accounts owned by the user |
GET/POST /v1/users/{slug}/tokens |
The user’s personal API tokens (your own only) |
/v1/users/{slug}/alert-subscriptions, /integrations, /telescopes, /observatories, /devices |
Other user-owned resources |
There is no endpoint that lists or fetches full user records by uid: use the public profile and directory endpoints for other users, and GET /v1/me for yourself. User creation goes through the auth service’s sign-up flow rather than the API — there is no POST /v1/users.
Visibility
Section titled “Visibility”- You always see your own full record, including email, through
GET /v1/me. - Public profiles (
UserPublic: name, username, slug, affiliation, location, links, and the other profile fields the user filled in) are what other callers see. Email addresses are not part of the public profile.
Common task recipes
Section titled “Common task recipes”- Look up a collaborator. Search
GET /v1/directory/entities?query=<name>&entity_type=user, then readGET /v1/public/entities/{slug}. - Update your profile.
PATCH /v1/users/{your-slug}with the fields to change (name,username,firstName,lastName,affiliation,description, links, …). Email and password changes go through the auth service. - Browse public profiles.
GET /v1/public/entities/{slug}/statsand/activityback the public profile view.