Sign in
latestOpenAPI 3.1.02026-08-22290519653.4 KB

136e4af4d514

auth

Get Current User Info

Returns information about the currently authenticated user.

Requires a valid Firebase ID token in the Authorization header. Includes auto-linking for users created in DB who log in via Google SSO.

Exempt from the terms gate: this is how the client learns it must prompt for acceptance, so gating it would leave the client unable to render the prompt that clears the gate.

get/api/v1/auth/me

Response

Successful Response

idstring uuid required
emailstring email required
usernamestring required
display_namestring nullable
workspace_namestring nullable
rolestring nullable
avatar_colorstring nullable
has_completed_onboardingboolean
plan_type'beta'

Available user plan types with different feature restrictions.

allowed_geographiesstring[]
available_enrichment_creditsinteger required
used_enrichment_creditsinteger required
created_atstring date-time nullable
updated_atstring date-time nullable
last_active_atstring date-time nullable
is_internalboolean
is_suspendedboolean
workspace_idstring uuid required
workspace_role'writer' | 'reader'

Role within a workspace determining permission level.

WRITER = can edit workspace_write projects READER = can only view workspace projects

is_workspace_adminboolean
workspace_member_countinteger
column_preferencesobject nullable
feature_togglesobject
terms_acceptance_requiredboolean
terms_versionstring
terms_urlstring
available_geographiesstring[] required

Get FIPS codes of counties this user can query.

Sourced from workspace_counties via enrich_profile_with_workspace_data, which reads the repository's access predicate — data present in the workspace's branch and not suspended. That covers a county loaded for this workspace and one that arrived with its branch alike. Empty list means the workspace has no county data yet.