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

# Join family with code

> Join by family code.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/families/join
openapi: 3.0.1
info:
  title: TKTChurch Identity (TKTAuth)
  version: v1
  description: >-
    Authorization server at prod-auth.tktchurch.com. Public OAuth2/OIDC
    endpoints need no auth; /api/v1 self routes need a Bearer access token
    issued to the user. the listed resource:action permission. Management lists
    return `{ metadata: { total, page, per }, items: [...] }`.
servers:
  - url: https://prod-auth.tktchurch.com
    description: Production
  - url: http://localhost:8080
    description: Local backchannel
  - url: https://calendar.tktchurch.net
    description: Calendar (Events)
security: []
tags:
  - name: authentication
    description: >-
      OAuth2 (RFC 6749), PAR (9126), revocation/introspection (7009/7662),
      device flow (8628), OIDC, registration (7591), sign-in flows, password
      reset and federated identity.
  - name: users
    description: >-
      Signed-in profile, identities, recovery, membership and Member Pass.
      Bearer only.
  - name: membership
    description: Membership matching, Member Pass, invite claims and family join codes.
  - name: sessions
    description: List, inspect and revoke your own sessions. Bearer only.
  - name: security
    description: TOTP setup and passkey management. Bearer only.
  - name: consents-privacy
    description: Your consent grants, privacy notices, data requests and exports.
  - name: family
    description: >-
      Families, dependents and guardian delegation. Bearer; delegation needs
      guardian:act_as.
  - name: system
    description: Liveness, readiness, build info and public maintenance status.
  - name: events
    description: >-
      Public church events listing, search and detail on calendar.tktchurch.net.
      No auth.
paths:
  /api/v1/families/join:
    post:
      tags:
        - membership
      summary: Join family with code
      description: Join by family code.
      operationId: joinFamilyWithCode
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FamilyJoin'
      responses:
        '201':
          description: Success
          content:
            application/json:
              example:
                family_id: fam_01
                status: member
              schema:
                $ref: '#/components/schemas/FamilyRef'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: invalid_request
                error_description: Redirect URI not registered for this client
      security: []
components:
  schemas:
    FamilyJoin:
      type: object
      properties:
        code:
          type: string
          description: Family join code (e.g. GRACE-42)
      required:
        - code
    FamilyRef:
      type: object
      properties:
        family_id:
          type: string
          description: Joined family
        status:
          type: string
          description: Membership status after join
    Error:
      type: object
      required:
        - error
        - error_description
      properties:
        error:
          type: string
          description: Machine-readable code
        error_description:
          type: string
          description: Human-readable detail

````