API referenceSign-in and account
Finish signing in with a 2FA code
POST
Exchanges the ticket from a secondFactor LoginResult and a 6-digit authenticator code (or one unused recovery code) for a session. A recovery code is used up.
Needs no sign-in. Not available to MCP clients or the assistant.
application/json- body
ticket*stringLength
1 <= length <= 200method*string|stringcode*stringLength
6 <= length <= 32Success.
application/json- response
viewer*recoveryCodesLeft*integerRange
0 <= valuecurl -X POST 'https://example.com/api/v1/auth.verifySecondFactor' \ -H 'Content-Type: application/json' \ -d '{ "ticket": "string", "method": "totp", "code": "string"}'Example Response
{ "viewer": { "id": "string", "email": "[email protected]", "name": "string", "role": "owner" }, "recoveryCodesLeft": 0}Change your name POST
Changes the display name of the signed-in person. Email changes go through an owner or admin (users.update). Any signed-in caller. Not available to MCP clients or the assistant.
Get the signed-in person GET
Returns who the current session or API key acts as, and through which credential. Any signed-in caller. Available to MCP clients and the assistant.