Sign in
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 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[]
national_county_coverageboolean
corpus_county_fipsstring[] nullable
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
agent_fill_row_ceilinginteger nullable
site_focusSiteFocus[]
site_focus_otherstring 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 entitlement predicate — granted and not suspended, wherever the county's data physically lives. That covers a county loaded for this workspace, one that arrived with its branch, and one a thin workspace reads from the shared corpus alike. Empty list means the workspace has been granted no counties.

Changes

Changed in 5 of the 30 revisions of this API.25

  • 8beaac28e1952See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 924eeadc29ad2See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 73f618ba0a7e1See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 97ae7fd86d441See the full diff
    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

  • d0e2bf840dfc1See the full diff
    • ▲

      the / response's property format changed from email to no format for status

      response-property-type-changed