> ## 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.

# Connect Personio With Client Credentials

> Connect Personio with customer-provided client credentials and optionally run the first people sync.



## OpenAPI

````yaml /openapi.json post /v1/sources/personio/connect
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/sources/personio/connect:
    post:
      tags:
        - sources
      summary: Connect Personio With Client Credentials
      description: >-
        Connect Personio with customer-provided client credentials and
        optionally run the first people sync.
      operationId: >-
        connect_personio_with_client_credentials_v1_sources_personio_connect_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PersonioConnectRequest'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PersonioConnectResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    PersonioConnectRequest:
      properties:
        workspace_id:
          type: string
          format: uuid
          title: Workspace Id
        client_id:
          type: string
          maxLength: 512
          minLength: 1
          title: Client Id
        client_secret:
          type: string
          maxLength: 2048
          minLength: 1
          title: Client Secret
        attributes:
          items:
            type: string
          type: array
          title: Attributes
        create_department_groups:
          type: boolean
          title: Create Department Groups
          default: false
        sync_now:
          type: boolean
          title: Sync Now
          default: true
      type: object
      required:
        - workspace_id
        - client_id
        - client_secret
      title: PersonioConnectRequest
    PersonioConnectResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        workspace_id:
          type: string
          format: uuid
          title: Workspace Id
        source_type:
          $ref: '#/components/schemas/SourceType'
        nango_connection_id:
          type: string
          title: Nango Connection Id
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
        sync_status:
          type: string
          title: Sync Status
        message:
          type: string
          title: Message
        fetched:
          type: integer
          title: Fetched
          default: 0
        upserted:
          type: integer
          title: Upserted
          default: 0
        skipped:
          type: integer
          title: Skipped
          default: 0
        stale_hidden:
          type: integer
          title: Stale Hidden
          default: 0
        groups_created:
          type: integer
          title: Groups Created
          default: 0
        groups_assigned:
          type: integer
          title: Groups Assigned
          default: 0
        attributes:
          items:
            type: string
          type: array
          title: Attributes
        create_department_groups:
          type: boolean
          title: Create Department Groups
      type: object
      required:
        - id
        - workspace_id
        - source_type
        - nango_connection_id
        - sync_status
        - message
        - attributes
        - create_department_groups
      title: PersonioConnectResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SourceType:
      type: string
      enum:
        - gmail
        - notion
        - google-drive
        - company-foundation
        - voice-session
        - hubspot
        - pipedrive
        - google-calendar
        - attio
        - personio
        - slack
        - manual
        - interview
        - gmail-send
        - msteams-send
      title: SourceType
    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_`).'
    HTTPBearer:
      type: http
      scheme: bearer

````