List companies accessible to the caller
Returns all companies accessible to the caller, from gosmarter.CompanyMembers (kept in sync from Clerk organizationMembership webhook events). Each company includes the caller's role ('admin' or 'member').
Headers
GoSmarter-Api-KeyThe GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
List companies accessible to the caller › Responses
Companies retrieved successfully
createdAtupdatedAtcompanyIdcompanyNameaddressList API keys
Returns the caller's consumer record and all their API keys.
List API keys › Responses
Rate Limiting Response
typeA URI reference that identifies the problem.
titleA short, human-readable summary of the problem.
statusThe HTTP status code.
instanceCreate API key
Upserts the caller's consumer record (syncing the user ID and roles) then creates a new API key. Company access for API-key requests is authorized per-request against the membership database, not key metadata.
Create API key › Responses
Rate Limiting Response
typeA URI reference that identifies the problem.
titleA short, human-readable summary of the problem.
statusThe HTTP status code.
instanceRoll API key
Creates a new API key for the caller's consumer and deletes all previous keys. Returns the new key.
Roll API key › Responses
Rate Limiting Response
typeA URI reference that identifies the problem.
titleA short, human-readable summary of the problem.
statusThe HTTP status code.
instanceUpdate caller's profile
Updates the authenticated caller's profile in the local database. Identity is derived from the gateway-injected X-User-Id header.
Headers
GoSmarter-Api-KeyThe GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Update caller's profile › Request Body
userIdfirstNamelastNametutorialModeUpdate caller's profile › Responses
Profile update accepted
userIdfirstNamelastNametutorialModeisSyncedCheck caller's sync status
Compares Clerk user values against the database for the authenticated caller. Returns DB values (or nulls) and isSynced flag.
Headers
GoSmarter-Api-KeyThe GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Check caller's sync status › Request Body
userIdfirstNamelastNametutorialModeCheck caller's sync status › Responses
Sync status and database values returned
userIdfirstNamelastNametutorialModeisSynced