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

# Retrieve Settings

> ## Current Settings Overview

Check your company's current configuration and preferences.
Passwords are hidden because we're not completely insane.




## OpenAPI

````yaml GET /settings
openapi: 3.0.3
info:
  title: Error Golf API - Where Code Goes to Die
  description: >
    # 🏌️ Error Golf API


    **Error Golf** replaces algorithmic tests with creative coding challenges
    that actually measure problem-solving skills.

    Companies pay $39 per candidate to discover if applicants can think
    creatively or just copy-paste from Stack Overflow.


    ## Business Model

    - **Setup Fee:** $49 one-time fee (because quality costs money)

    - **Per Candidate:** $39 each attempt (cheaper than a decent lunch)

    - **No Subscriptions:** We're not Netflix


    ## Golf Terminology

    - **Round:** Complete test (3 questions, like actual golf but with more
    crying)

    - **Hole:** Individual question (candidates pick 3 from 100 nightmares)

    - **Shot:** Solution attempt (usually involves existential crisis)

    - **Scorecard:** A roast of your code from 3 different personalities


    ## Authentication

    Protected endpoints need JWT Bearer token: `Bearer <your-digital-passport>`


    ## Error Responses

    When things inevitably break:

    ```json

    {
      "error": "something_went_sideways",
      "message": "A helpful explanation of what you did wrong this time"
    }

    ```


    ## Rate Limiting

    - 100 requests/hour (generous, considering your coding skills)

    - Headers tell you when we'll start ignoring you
  version: 1.0.0
  contact:
    name: Error Golf Support (May the odds be ever in your favor)
    url: https://errorgolf.com/support
    email: support@errorgolf.com
  license:
    name: Proprietary (We own this beautiful mess)
    url: https://errorgolf.com/terms
servers:
  - url: https://api.errorgolf.com/v1
    description: Production (where dreams meet reality)
  - url: http://localhost:8080/v1
    description: Local dev (your personal playground)
security: []
tags:
  - name: Health
    description: Is this thing even working?
  - name: Course
    description: Browse the vault of coding nightmares
  - name: Round
    description: Take 3 swings at holes you pick
  - name: Members
    description: Prove you belong here
  - name: Clubhouse
    description: Configure your coding challenge empire
paths:
  /settings:
    get:
      tags:
        - Clubhouse
      summary: View current configuration
      description: |
        ## Current Settings Overview

        Check your company's current configuration and preferences.
        Passwords are hidden because we're not completely insane.
      responses:
        '200':
          description: Current configuration retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanySettings'
        '401':
          $ref: '#/components/responses/TokenDead'
        '500':
          $ref: '#/components/responses/ServerExistentialCrisis'
      security:
        - bearerAuth: []
components:
  schemas:
    CompanySettings:
      type: object
      description: Company configuration and preferences
      properties:
        name:
          type: string
          description: Company name
          example: TechCorp Solutions
        email:
          type: string
          description: Company email address
          example: hiring@techcorp.com
        live_code:
          type: string
          description: Live evaluation code (charges $39 per completion)
          example: 1AB2CD3EF4
        test_code:
          type: string
          description: Test code for webhook testing and development
          example: T123456789
        personalities:
          type: array
          items:
            type: string
          minItems: 3
          maxItems: 3
          description: Personalities for evaluation (first, second, third)
          example:
            - jaded_dev
            - caffeinated_genius
            - mad_scientist
        webhook_url:
          type: string
          nullable: true
          description: Webhook URL for result notifications
          example: https://api.yourcompany.com/webhooks/error-golf
        webhook_secret:
          type: string
          nullable: true
          description: Secret for webhook signature verification
          example: abc123def456ghi789
        per_candidate:
          type: integer
          minimum: 1
          maximum: 4
          description: Maximum attempts allowed per candidate
          example: 2
        created_at:
          type: string
          format: date-time
          example: '2025-07-03T01:01:50.474Z'
        updated_at:
          type: string
          format: date-time
          example: '2025-07-04T01:46:27.018Z'
    ErrorResponse:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: Machine-readable error identifier
        message:
          type: string
          description: Human-readable error explanation
  responses:
    TokenDead:
      description: JWT token is invalid or has expired
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: token_expired
            message: Your authentication token has expired. Please login again.
    ServerExistentialCrisis:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: internal_server_error
            message: Something went wrong on our end. We're looking into it.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token from /token endpoint

````