> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt
> Use this file to discover all available pages before exploring further.

# Start WorkOS authorization flow

> Public endpoint invoked by the browser to begin WorkOS AuthKit sign-in. Builds the authorization URL with redirect_uri, state, optional login_hint/organization_id/prompt and responds with a 302 redirect to WorkOS.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/auth/workos/authorize
openapi: 3.0.3
info:
  title: Tether Relay and Tether API
  version: 1.0.0
  description: >-
    Route-derived OpenAPI contract generated from tether-relay backend sources.
    Regenerate with scripts/sync-openapi-from-backend.mjs.
servers:
  - url: https://your-instance.example.com
    description: Production
  - url: http://localhost:2212
    description: Local API service
security: []
tags:
  - name: AI
  - name: Applications
  - name: Approval
  - name: Auth
  - name: Automations
  - name: Calls
  - name: Campaigns
  - name: Contact Analytics
  - name: Contact Metrics
  - name: Contact Notes
  - name: Contacts
  - name: Conversation Monitor
  - name: Conversations
  - name: Departments
  - name: Email
  - name: Escalation Dashboard
  - name: Event Logs
  - name: Google Sheets
  - name: Marketplace
  - name: Messages
  - name: Notification Sounds
  - name: Notifications
  - name: Org Snapshots
  - name: Organizations
  - name: Outreach
  - name: Outreach Metrics
  - name: Outreach Sources
  - name: Pipelines
  - name: Processes
  - name: Prompts
  - name: Reminders
  - name: Sms
  - name: Templates
  - name: Traces
  - name: Training
  - name: Upload
  - name: User Snapshots
  - name: Users
  - name: Vertical
  - name: Webchats
  - name: Webhook
paths:
  /api/auth/workos/authorize:
    get:
      tags:
        - Auth
      summary: Start WorkOS authorization flow
      description: >-
        Public endpoint invoked by the browser to begin WorkOS AuthKit sign-in.
        Builds the authorization URL with redirect_uri, state, optional
        login_hint/organization_id/prompt and responds with a 302 redirect to
        WorkOS.
      operationId: get_auth_workos_authorize
      parameters:
        - in: query
          name: redirect_uri
          required: false
          schema:
            type: string
        - in: query
          name: state
          required: false
          schema:
            type: string
        - in: query
          name: login_hint
          required: false
          schema:
            type: string
        - in: query
          name: organization_id
          required: false
          schema:
            type: string
          description: Only forwarded when the value starts with "org_".
        - in: query
          name: prompt
          required: false
          schema:
            type: string
      responses:
        '302':
          description: Redirect to WorkOS authorization URL
        '400':
          description: WorkOS is not enabled or client id missing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthErrorResponse'
        '500':
          description: Failed to initiate WorkOS login
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthErrorResponse'
components:
  schemas:
    AuthErrorResponse:
      type: object
      description: >-
        Generic error envelope returned by Auth endpoints. Most paths include
        only `error`; a few add `details`/`code` for diagnostic context.
      properties:
        error:
          type: string
        details:
          type: string
        code:
          type: string
      required:
        - error
      additionalProperties: true
      example:
        error: Invalid or expired token
        code: TOKEN_EXPIRED

````