Sign in

v3

latestOpenAPI 3.1.02026-08-06274467602.9 KB
auth

Check Authentication

Checks if the user is authenticated and returns user info if they are.

Does not require authentication - returns null if no valid token is provided. Falls back to email lookup if Firebase UID doesn't match database ID. When found via email fallback, updates the user's database ID to match the new Firebase-derived ID to prevent future mismatches.

get/api/v1/auth/check

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 (rows with load_status='succeeded') via enrich_profile_with_workspace_data — see MAIA-1562. Empty list means the user's workspace has no counties loaded yet.