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

# Register Via Join Link

> Register a participant (name + email) and hand over to the booking flow.

First registration under an email returns the personal booking link
directly (status "registered"). If the email already belongs to a contact
on this campaign — an earlier self-registration or a roster invitee — the
link is re-sent to that inbox instead and the response carries only status
"email_sent": knowing an address must never yield that contact's booking
token, which is their bearer credential for booking, their conversation,
and their results. Registrations that may create a contact serialize on
the interview row.

Email is otherwise unverified — registering under someone else's unused
address creates a contact in their name (equivalent to using any made-up
address, bounded by MAX_JOIN_CONTACTS). The "email_sent" branch does
reveal that an address is already on the campaign to anyone holding the
join link; accepted as the cost of handing first-time registrants their
link without an email round-trip.



## OpenAPI

````yaml /openapi.json post /v1/join/{token}
openapi: 3.1.0
info:
  title: Ontora API
  description: >-
    Ontora's public API. Covers interview campaigns, transcripts, synthesis
    reports, graph queries, webhooks, and workspace management. 


    **Authentication**: endpoints accept either a Clerk JWT (`Authorization:
    Bearer <token>`) or a workspace API key (`X-API-Key: ont_...`). Workspace
    keys are managed via `/v1/api-keys`.
  version: 0.1.0
servers: []
security:
  - ClerkJWT: []
  - WorkspaceApiKey: []
tags:
  - name: interviews
    description: Campaign CRUD, lifecycle, contacts, question sets.
  - name: campaign-insights
    description: Synthesis outputs — cartography, roadmap, personas, conversations.
  - name: interview-query
    description: Graph RAG query over campaign data.
  - name: campaign-reports
    description: Versioned synthesis Reports — manual regenerate, version history.
  - name: interview-export
    description: Markdown / ZIP exports of transcripts and reports.
  - name: api-keys
    description: Manage workspace-scoped API keys for programmatic access.
  - name: webhook-endpoints
    description: Outbound webhook endpoints for automation.
  - name: booking
    description: Public self-scheduling endpoints for interview participants.
  - name: join
    description: Public QR-code / share-link self-registration for campaign participants.
  - name: workspaces
    description: Workspace and membership management.
  - name: vaults
    description: Context vault management.
paths:
  /v1/join/{token}:
    post:
      tags:
        - join
      summary: Register Via Join Link
      description: >-
        Register a participant (name + email) and hand over to the booking flow.


        First registration under an email returns the personal booking link

        directly (status "registered"). If the email already belongs to a
        contact

        on this campaign — an earlier self-registration or a roster invitee —
        the

        link is re-sent to that inbox instead and the response carries only
        status

        "email_sent": knowing an address must never yield that contact's booking

        token, which is their bearer credential for booking, their conversation,

        and their results. Registrations that may create a contact serialize on

        the interview row.


        Email is otherwise unverified — registering under someone else's unused

        address creates a contact in their name (equivalent to using any made-up

        address, bounded by MAX_JOIN_CONTACTS). The "email_sent" branch does

        reveal that an address is already on the campaign to anyone holding the

        join link; accepted as the cost of handing first-time registrants their

        link without an email round-trip.
      operationId: register_via_join_link_v1_join__token__post
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
            title: Token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JoinRegisterRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JoinRegisterResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    JoinRegisterRequest:
      properties:
        name:
          type: string
          maxLength: 255
          minLength: 1
          title: Name
        email:
          type: string
          format: email
          title: Email
      type: object
      required:
        - name
        - email
      title: JoinRegisterRequest
    JoinRegisterResponse:
      properties:
        status:
          type: string
          enum:
            - registered
            - email_sent
          title: Status
          default: registered
        booking_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Booking Token
        booking_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Booking Url
      type: object
      title: JoinRegisterResponse
    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:
    ClerkJWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk-issued RS256 JWT.
    WorkspaceApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Workspace-scoped API key (prefix: `ont_`).'

````