openapi: 3.2.0
info:
  description: The One API. Universal API integration platform for AI agents and applications.
  license:
    name: ''
  title: One Connectors API
  version: 5.35.0
tags:
- description: List available connectors
  name: Connectors
paths:
  /v1/available-connectors:
    get:
      description: Returns the public catalog of connectors (platforms) available on One. Filter by platform, key, or display name. Pass `authkit=true` (with an authenticated API key) to restrict the listing to the connectors enabled for the caller's tenant in AuthKit settings.
      operationId: list_connectors
      parameters:
      - in: query
        name: page
        required: true
        schema:
          $ref: '#/components/schemas/Page'
      - description: Filter by platform identifier (e.g. `gmail`, `shopify`).
        in: query
        name: platform
        required: false
        schema:
          type: string
      - description: Filter by exact connector key.
        in: query
        name: key
        required: false
        schema:
          type: string
      - description: Filter by display name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: 'When `true`, restrict the listing to the connectors enabled for the

          caller''s tenant in AuthKit settings (scoped by project, organization,

          or user, matching the API key). Ignored for unauthenticated callers.'
        in: query
        name: authkit
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Paginated_AvailableConnectorView'
          description: Paginated list of available connectors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      summary: List Connectors
      tags:
      - Connectors
  /v1/available-connectors/connected:
    get:
      description: Returns only the connectors the authenticated caller has actively connected in the current environment. Requires authentication.
      operationId: list_connected_connectors
      parameters:
      - in: query
        name: page
        required: true
        schema:
          $ref: '#/components/schemas/Page'
      - description: Filter by platform identifier (e.g. `gmail`, `shopify`).
        in: query
        name: platform
        required: false
        schema:
          type: string
      - description: Filter by exact connector key.
        in: query
        name: key
        required: false
        schema:
          type: string
      - description: Filter by display name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: 'When `true`, restrict the listing to the connectors enabled for the

          caller''s tenant in AuthKit settings (scoped by project, organization,

          or user, matching the API key). Ignored for unauthenticated callers.'
        in: query
        name: authkit
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Paginated_AvailableConnectorView'
          description: Paginated list of connected connectors
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Internal server error
      security:
      - Session: []
      - X-One-Secret: []
      summary: List Connected Connectors
      tags:
      - Connectors
components:
  schemas:
    ConnectionStatusType:
      enum:
      - not_available
      - beta
      - alpha
      - generally_available
      type: string
    Paginated_AvailableConnectorView:
      properties:
        page:
          format: int64
          minimum: 0
          type: integer
        pages:
          format: int64
          minimum: 0
          type: integer
        rows:
          items:
            properties:
              active:
                type: boolean
              category:
                type: string
              description:
                type: string
              id:
                $ref: '#/components/schemas/ConnectionDefinitionId'
              image:
                type: string
              key:
                type: string
              name:
                type: string
              oauth:
                type: boolean
              oauthScopes:
                oneOf:
                - type: 'null'
                - $ref: '#/components/schemas/OAuthScopesView'
              platform:
                type: string
              platformVersion:
                type: string
              status:
                $ref: '#/components/schemas/ConnectionStatusType'
              tags:
                items:
                  type: string
                type: array
              title:
                type:
                - string
                - 'null'
              tools:
                format: int32
                type: integer
              version:
                type: string
            required:
            - id
            - name
            - platformVersion
            - status
            - key
            - platform
            - description
            - category
            - image
            - tags
            - tools
            - oauth
            - version
            - active
            type: object
          type: array
        total:
          format: int64
          minimum: 0
          type: integer
      required:
      - rows
      - total
      - pages
      - page
      type: object
    ErrorResponse:
      properties:
        correlationId:
          example: 550e8400-e29b-41d4-a716-446655440000
          type: string
        key:
          example: http_error
          type: string
        message:
          example: Authentication required
          type: string
        status:
          example: 401
          format: int32
          minimum: 0
          type: integer
        type:
          example: http_error
          type: string
      required:
      - correlationId
      - key
      - message
      - type
      - status
      type: object
    OAuthScopesView:
      description: 'OAuth scope metadata for a connector, surfaced on the available-connectors

        list only when the connector supports OAuth.'
      properties:
        raw:
          description: The exact scope string as stored, before splitting.
          type: string
        scopes:
          description: Individual OAuth scopes the connector requests.
          items:
            type: string
          type: array
        separator:
          description: 'Delimiter used to join the scopes onto the provider authorization URL.

            `null` means the OAuth 2.0 default of a single space.'
          type:
          - string
          - 'null'
      required:
      - scopes
      - raw
      type: object
    ConnectionDefinitionId:
      description: Prefixed ID with 'conn_def' prefix (e.g., 'conn_def_1C'), also accepts raw integer
      type: string
    Page:
      properties:
        limit:
          description: 'Items per page. Default 20, hard-capped at 150. `limit=0` is

            treated as 1. Larger values silently clamp.'
          format: int64
          minimum: 0
          type: integer
        page:
          description: Page number for pagination (1-indexed). Defaults to 1.
          format: int64
          minimum: 0
          type: integer
        skip:
          description: 'Number of items to skip before the first returned item. Defaults to 0.

            Most callers should leave this at 0 and rely on `page` + `limit`.'
          format: int64
          minimum: 0
          type: integer
      type: object
  securitySchemes:
    Bearer:
      scheme: bearer
      type: http
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://api.withone.ai/oauth/authorize
          scopes:
            org:ai_skills:read: Read organization AI skills
            org:ai_skills:write: Create, update, and delete organization AI skills
            org:authkit:read: Read organization AuthKit resources
            org:authkit:write: Create, update, and delete organization AuthKit resources
            org:connections:read: Read organization connections
            org:connections:write: Create, update, and delete organization connections
            org:projects:read: Read organization projects
            org:projects:write: Create, update, and delete organization projects
            org:secrets:read: Read organization secrets
            org:secrets:write: Create, update, and delete organization secrets
            org:workflows:executions:read: Read organization workflow executions
            org:workflows:executions:write: Create, update, and delete organization workflow executions
            org:workflows:read: Read organization workflows
            org:workflows:write: Create, update, and delete organization workflows
            project:ai_skills:read: Read project AI skills
            project:ai_skills:write: Create, update, and delete project AI skills
            project:authkit:read: Read project AuthKit resources
            project:authkit:write: Create, update, and delete project AuthKit resources
            project:connections:read: Read project connections
            project:connections:write: Create, update, and delete project connections
            project:secrets:read: Read project secrets
            project:secrets:write: Create, update, and delete project secrets
            project:workflows:executions:read: Read project workflow executions
            project:workflows:executions:write: Create, update, and delete project workflow executions
            project:workflows:read: Read project workflows
            project:workflows:write: Create, update, and delete project workflows
            user:ai_skills:read: Read your personal AI skills
            user:ai_skills:write: Create, update, and delete your personal AI skills
            user:authkit:read: Read your personal AuthKit resources
            user:authkit:write: Create, update, and delete your personal AuthKit resources
            user:connections:read: Read your personal connections
            user:connections:write: Create, update, and delete your personal connections
            user:secrets:read: Read your personal secrets
            user:secrets:write: Create, update, and delete your personal secrets
            user:workflows:executions:read: Read your personal workflow executions
            user:workflows:executions:write: Create, update, and delete your personal workflow executions
            user:workflows:read: Read your personal workflows
            user:workflows:write: Create, update, and delete your personal workflows
          tokenUrl: https://api.withone.ai/oauth/token
      type: oauth2
    Session:
      in: cookie
      name: withone
      type: apiKey
    X-One-Connection-Key:
      in: header
      name: X-One-Connection-Key
      type: apiKey
    X-One-Secret:
      in: header
      name: X-One-Secret
      type: apiKey
    X-Pica-Connection-Key:
      in: header
      name: X-One-Connection-Key
      type: apiKey
    X-Pica-Secret:
      in: header
      name: X-One-Secret
      type: apiKey