NudgeLink Auth API
The auth API from NudgeLink — 15 operation(s) for auth.
The auth API from NudgeLink — 15 operation(s) for auth.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/nudgelink-co:nudgelink-co-auth-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: NudgeLink Auth API
version: 0.1.0
tags:
- name: Auth
paths:
/api/v1/auth/register:
post:
tags:
- Auth
summary: Register
operationId: register_api_v1_auth_register_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterRequest'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MeResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/auth/verify-email:
get:
tags:
- Auth
summary: Verify Email
operationId: verify_email_api_v1_auth_verify_email_get
parameters:
- name: token
in: query
required: true
schema:
type: string
title: Token
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/auth/resend-verification:
post:
tags:
- Auth
summary: Resend Verification
operationId: resend_verification_api_v1_auth_resend_verification_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ForgotPasswordRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/auth/login:
post:
tags:
- Auth
summary: Login
operationId: login_api_v1_auth_login_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LoginRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TokenPair'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/auth/refresh:
post:
tags:
- Auth
summary: Refresh
operationId: refresh_api_v1_auth_refresh_post
parameters:
- name: nudgelink_refresh
in: cookie
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Nudgelink Refresh
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/RefreshRequest'
- type: 'null'
title: Req
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TokenPair'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/auth/me:
get:
tags:
- Auth
summary: Me
operationId: me_api_v1_auth_me_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MeResponse'
security:
- HTTPBearer: []
patch:
tags:
- Auth
summary: Update Me
operationId: update_me_api_v1_auth_me_patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMeRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MeResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/auth/logout:
post:
tags:
- Auth
summary: Logout
operationId: logout_api_v1_auth_logout_post
responses:
'204':
description: Successful Response
security:
- HTTPBearer: []
/api/v1/auth/forgot-password:
post:
tags:
- Auth
summary: Forgot Password
operationId: forgot_password_api_v1_auth_forgot_password_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ForgotPasswordRequest'
required: true
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/auth/reset-password:
post:
tags:
- Auth
summary: Reset Password
operationId: reset_password_api_v1_auth_reset_password_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResetPasswordRequest'
required: true
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/auth/totp/setup:
post:
tags:
- Auth
summary: Totp Setup
description: 'Generate a new TOTP secret. Returns provisioning URI for QR code.
The secret is stored as *pending* until confirmed with /totp/confirm.'
operationId: totp_setup_api_v1_auth_totp_setup_post
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TotpSetupResponse'
security:
- HTTPBearer: []
/api/v1/auth/totp/confirm:
post:
tags:
- Auth
summary: Totp Confirm
description: Confirm 2FA setup by verifying a code from the authenticator app.
operationId: totp_confirm_api_v1_auth_totp_confirm_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TotpConfirmRequest'
required: true
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/auth/totp/disable:
post:
tags:
- Auth
summary: Totp Disable
description: Disable 2FA - requires a valid current code.
operationId: totp_disable_api_v1_auth_totp_disable_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TotpConfirmRequest'
required: true
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
/api/v1/auth/google/login:
get:
tags:
- Auth
summary: Google Login
description: 'Generate a state, store it (with any affiliate ``ref`` code for first-touch
attribution), and redirect to Google.'
operationId: google_login_api_v1_auth_google_login_get
parameters:
- name: ref
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Ref
- name: next
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Next
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/auth/google/callback:
get:
tags:
- Auth
summary: Google Callback
description: 'Verify state, exchange code for ID token, find-or-create Client,
issue NudgeLink JWT pair, redirect to dashboard.'
operationId: google_callback_api_v1_auth_google_callback_get
parameters:
- name: code
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Code
- name: state
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: State
- name: error
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Error
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/auth/google/mfa:
post:
tags:
- Auth
summary: Google Mfa
description: 'Finish a Google sign-in for a 2FA account: challenge + authenticator code.
Brute force is bounded per challenge (``_MFA_MAX_ATTEMPTS`` wrong codes and
it is deleted), per account and per network across challenges
(``_MFA_MAX_FAILURES_PER_*`` wrong codes lock this step for
``_MFA_LOCK_SECONDS``), and a code that already signed in is refused. No
``@limiter.limit`` here: this module has ``from __future__ import
annotations`` (the PEP 563 + slowapi hazard).'
operationId: google_mfa_api_v1_auth_google_mfa_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GoogleMfaRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
GoogleMfaRequest:
properties:
challenge:
type: string
maxLength: 128
minLength: 16
title: Challenge
totp_code:
type: string
maxLength: 16
minLength: 1
title: Totp Code
type: object
required:
- challenge
- totp_code
title: GoogleMfaRequest
TotpConfirmRequest:
properties:
code:
type: string
maxLength: 6
minLength: 6
title: Code
type: object
required:
- code
title: TotpConfirmRequest
TokenPair:
properties:
access_token:
type: string
title: Access Token
refresh_token:
type: string
title: Refresh Token
default: ''
token_type:
type: string
title: Token Type
default: bearer
type: object
required:
- access_token
title: TokenPair
TotpSetupResponse:
properties:
secret:
type: string
title: Secret
provisioning_uri:
type: string
title: Provisioning Uri
type: object
required:
- secret
- provisioning_uri
title: TotpSetupResponse
MeResponse:
properties:
id:
type: string
format: uuid
title: Id
email:
type: string
format: email
title: Email
company_name:
type: string
title: Company Name
industry:
type: string
title: Industry
default: ''
languages:
items:
type: string
type: array
title: Languages
default: []
outreach_auto_send:
type: boolean
title: Outreach Auto Send
default: false
role:
$ref: '#/components/schemas/ClientRole'
email_verified:
type: boolean
title: Email Verified
has_icp:
type: boolean
title: Has Icp
has_style_profile:
type: boolean
title: Has Style Profile
has_linkedin_account:
type: boolean
title: Has Linkedin Account
subscription_plan:
anyOf:
- type: string
- type: 'null'
title: Subscription Plan
totp_enabled:
type: boolean
title: Totp Enabled
default: false
campaign_first_ux:
type: boolean
title: Campaign First Ux
default: false
ui_tour_state:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Ui Tour State
avg_deal_size_usd:
anyOf:
- type: number
- type: 'null'
title: Avg Deal Size Usd
booking_url:
anyOf:
- type: string
- type: 'null'
title: Booking Url
outreach_mode_switched:
anyOf:
- type: integer
- type: 'null'
title: Outreach Mode Switched
entitlements:
additionalProperties: true
type: object
title: Entitlements
created_at:
type: string
format: date-time
title: Created At
type: object
required:
- id
- email
- company_name
- role
- email_verified
- has_icp
- has_style_profile
- has_linkedin_account
- subscription_plan
- created_at
title: MeResponse
ClientRole:
type: string
enum:
- client
- admin
title: ClientRole
ForgotPasswordRequest:
properties:
email:
type: string
format: email
title: Email
type: object
required:
- email
title: ForgotPasswordRequest
RegisterRequest:
properties:
email:
type: string
format: email
title: Email
password:
type: string
maxLength: 128
minLength: 12
title: Password
company_name:
type: string
maxLength: 255
title: Company Name
default: ''
referral_code:
anyOf:
- type: string
maxLength: 64
- type: 'null'
title: Referral Code
type: object
required:
- email
- password
title: RegisterRequest
LoginRequest:
properties:
email:
type: string
format: email
title: Email
password:
type: string
title: Password
totp_code:
anyOf:
- type: string
- type: 'null'
title: Totp Code
type: object
required:
- email
- password
title: LoginRequest
UpdateMeRequest:
properties:
company_name:
anyOf:
- type: string
maxLength: 255
- type: 'null'
title: Company Name
current_password:
anyOf:
- type: string
- type: 'null'
title: Current Password
new_password:
anyOf:
- type: string
maxLength: 128
minLength: 12
- type: 'null'
title: New Password
outreach_auto_send:
anyOf:
- type: boolean
- type: 'null'
title: Outreach Auto Send
languages:
anyOf:
- items:
type: string
type: array
maxItems: 20
- type: 'null'
title: Languages
ui_tour_state:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Ui Tour State
avg_deal_size_usd:
anyOf:
- type: number
maximum: 1000000000.0
minimum: 0.0
- type: 'null'
title: Avg Deal Size Usd
booking_url:
anyOf:
- type: string
maxLength: 500
- type: 'null'
title: Booking Url
type: object
title: UpdateMeRequest
ResetPasswordRequest:
properties:
token:
type: string
title: Token
new_password:
type: string
maxLength: 128
minLength: 12
title: New Password
type: object
required:
- token
- new_password
title: ResetPasswordRequest
RefreshRequest:
properties:
refresh_token:
anyOf:
- type: string
- type: 'null'
title: Refresh Token
type: object
title: RefreshRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer