API Reference
Authentication and Profile
Session, password, verification, and profile endpoints.
Overview
PinBridge supports JWT session tokens and API keys. Auth responses include organization and project context for multi-project workspaces.
What You Will Learn
- Auth response payload shape: access token, organization, active project, and projects list.
- Password reset, password change, and email verification lifecycle.
- Profile endpoints for workspace invoice/customer details.
Implementation Checklist
- Use register/login for user sessions and store bearer tokens securely.
- Call /v1/auth/me after login to hydrate organization and project context.
- Use /v1/auth/change-password for in-session changes and forgot/reset for recovery.
- Use /v1/auth/profile GET/PUT for billing profile updates.
- Handle 400/401/409 auth errors with explicit UX guidance.
Relevant Endpoints
POST
/v1/auth/registerCreate user, organization, and production project.
POST
/v1/auth/loginAuthenticate and return session payload.
GET
/v1/auth/meCurrent user + organization + project context.
POST
/v1/auth/forgot-passwordStart password reset flow.
POST
/v1/auth/reset-passwordComplete password reset flow.
POST
/v1/auth/change-passwordChange password while authenticated.
POST
/v1/auth/email/verify/requestSend verification email.
GET
/v1/auth/email/verify?token=...Verify email from token.
GET
/v1/auth/profileGet billing profile fields.
PUT
/v1/auth/profileUpdate billing profile fields.