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

# Onboarding Signup



## OpenAPI

````yaml /openapi/groundforge-openapi-v1.json post /v1/onboarding/signup
openapi: 3.1.0
info:
  title: GroundForge REST API
  version: 86Y.5p.6v.6aq
  description: >-
    Current GroundForge SaaS administration, Agent, Channel, MCP, governance,
    observability, and LangChain integration endpoints.
servers:
  - url: https://platform.groundforge.ai
    description: GroundForge SaaS
security: []
paths:
  /v1/onboarding/signup:
    post:
      summary: Onboarding Signup
      operationId: onboarding_signup_v1_onboarding_signup_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnboardingSignupRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security: []
components:
  schemas:
    OnboardingSignupRequest:
      properties:
        user:
          $ref: '#/components/schemas/SignupUserInput'
        organization:
          $ref: '#/components/schemas/SignupOrganizationInput'
        team:
          $ref: '#/components/schemas/OnboardingTeamInput'
        source:
          anyOf:
            - type: string
              maxLength: 128
              minLength: 1
            - type: 'null'
          title: Source
          default: public_signup
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
      additionalProperties: false
      type: object
      required:
        - user
        - organization
        - team
      title: OnboardingSignupRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SignupUserInput:
      properties:
        email:
          type: string
          maxLength: 320
          minLength: 5
          title: Email
        displayName:
          type: string
          maxLength: 160
          minLength: 1
          title: Displayname
        terms:
          $ref: '#/components/schemas/TermsAcceptanceInput'
        marketingConsent:
          $ref: '#/components/schemas/MarketingConsentInput'
      additionalProperties: false
      type: object
      required:
        - email
        - displayName
        - terms
      title: SignupUserInput
    SignupOrganizationInput:
      properties:
        name:
          type: string
          maxLength: 160
          minLength: 2
          title: Name
        slug:
          type: string
          maxLength: 63
          minLength: 2
          title: Slug
        primaryDomain:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 3
            - type: 'null'
          title: Primarydomain
      additionalProperties: false
      type: object
      required:
        - name
        - slug
      title: SignupOrganizationInput
    OnboardingTeamInput:
      properties:
        name:
          type: string
          maxLength: 160
          minLength: 1
          title: Name
          default: Default
        slug:
          type: string
          maxLength: 63
          minLength: 1
          title: Slug
          default: default
        isDefault:
          type: boolean
          title: Isdefault
          default: true
      additionalProperties: false
      type: object
      title: OnboardingTeamInput
    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
    TermsAcceptanceInput:
      properties:
        accepted:
          type: boolean
          title: Accepted
          default: false
        termsVersion:
          type: string
          maxLength: 128
          minLength: 1
          title: Termsversion
        privacyVersion:
          type: string
          maxLength: 128
          minLength: 1
          title: Privacyversion
      additionalProperties: false
      type: object
      required:
        - termsVersion
        - privacyVersion
      title: TermsAcceptanceInput
    MarketingConsentInput:
      properties:
        optedIn:
          type: boolean
          title: Optedin
          default: false
        consentVersion:
          anyOf:
            - type: string
              maxLength: 128
            - type: 'null'
          title: Consentversion
      additionalProperties: false
      type: object
      title: MarketingConsentInput

````

## Related topics

- [Onboarding Register](/api-reference/endpoints/onboarding-register.md)
- [Onboarding Create Organization](/api-reference/endpoints/onboarding-create-organization.md)
