ctlsurf Shares API

openapi: 3.2.0
info:
  title: Ctlsurf Com Shares API
  version: 0.1.0
  description: 'Operations tagged shares across 2 of this provider''s published API definitions: ctlsurf-com-openapi.json, ctlsurf-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.ctlsurf.com
  description: ctlsurf application host (documented MCP endpoint https://app.ctlsurf.com/api/mcp; spec served at /openapi.json)
tags:
- name: Shares
paths:
  /api/shares/pages/{page_id}:
    post:
      tags:
      - Shares
      summary: Share Page
      description: 'Share a page with another user. Supports different scopes:

        - single: Just this page

        - with_children: This page and all sub-pages

        - folder: Share the entire folder (if page belongs to one)'
      operationId: share_page_api_shares_pages__page_id__post
      security:
      - HTTPBearer: []
      parameters:
      - name: page_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Page Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PageShareCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageShareResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Shares
      summary: List Page Shares
      description: List all shares for a page. Only the owner can see this.
      operationId: list_page_shares_api_shares_pages__page_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: page_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Page Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageShareListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/shares/pages/{page_id}/{share_id}:
    patch:
      tags:
      - Shares
      summary: Update Page Share
      description: Update a page share's permission. Only the owner can do this.
      operationId: update_page_share_api_shares_pages__page_id___share_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: page_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Page Id
      - name: share_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Share Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PageShareUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageShareResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Shares
      summary: Revoke Page Share
      description: Revoke a page share. Owner or the shared user can do this.
      operationId: revoke_page_share_api_shares_pages__page_id___share_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: page_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Page Id
      - name: share_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Share Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/shares/folders/{folder_id}:
    post:
      tags:
      - Shares
      summary: Share Folder
      description: Share a folder with another user.
      operationId: share_folder_api_shares_folders__folder_id__post
      security:
      - HTTPBearer: []
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Folder Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FolderShareCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderShareResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Shares
      summary: List Folder Shares
      description: List all shares for a folder. Only the owner can see this.
      operationId: list_folder_shares_api_shares_folders__folder_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Folder Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderShareListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/shares/folders/{folder_id}/{share_id}:
    patch:
      tags:
      - Shares
      summary: Update Folder Share
      description: Update a folder share. Only the owner can do this.
      operationId: update_folder_share_api_shares_folders__folder_id___share_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Folder Id
      - name: share_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Share Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FolderShareUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderShareResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Shares
      summary: Revoke Folder Share
      description: Revoke a folder share. Owner or the shared user can do this.
      operationId: revoke_folder_share_api_shares_folders__folder_id___share_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Folder Id
      - name: share_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Share Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/shares/shared-with-me:
    get:
      tags:
      - Shares
      summary: Get Shared With Me
      description: Get all pages and folders shared with the current user.
      operationId: get_shared_with_me_api_shares_shared_with_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedWithMeResponse'
      security:
      - HTTPBearer: []
  /api/shares/my-shares:
    get:
      tags:
      - Shares
      summary: Get My Shares
      description: Get all pages and folders the current user has shared with others.
      operationId: get_my_shares_api_shares_my_shares_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MySharesResponse'
      security:
      - HTTPBearer: []
  /api/shares/organization/pages/{page_id}:
    post:
      tags:
      - Shares
      summary: Share Page With Org
      description: Share a page with everyone holding a seat in your organization.
      operationId: share_page_with_org_api_shares_organization_pages__page_id__post
      security:
      - HTTPBearer: []
      parameters:
      - name: page_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Page Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrgShareRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Shares
      summary: Unshare Page With Org
      operationId: unshare_page_with_org_api_shares_organization_pages__page_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: page_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Page Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/shares/organization/folders/{folder_id}:
    post:
      tags:
      - Shares
      summary: Share Folder With Org
      description: Share a whole project (every page, including new ones; private pages stay hidden) with your organization.
      operationId: share_folder_with_org_api_shares_organization_folders__folder_id__post
      security:
      - HTTPBearer: []
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Folder Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrgShareRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Shares
      summary: Unshare Folder With Org
      operationId: unshare_folder_with_org_api_shares_organization_folders__folder_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: folder_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Folder Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/shares/organization/pages/{page_id}/status:
    get:
      tags:
      - Shares
      summary: Page Org Share Status
      description: 'What the share dialog needs: your org, its outside-sharing rule, and this page''s org shares.'
      operationId: page_org_share_status_api_shares_organization_pages__page_id__status_get
      security:
      - HTTPBearer: []
      parameters:
      - name: page_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Page Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/shares/organization:
    get:
      tags:
      - Shares
      summary: Shared With My Organization
      description: Projects and pages teammates have shared with your organization (not your own).
      operationId: shared_with_my_organization_api_shares_organization_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharedWithMeResponse'
      security:
      - HTTPBearer: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MyFolderShareInfo:
      properties:
        share_id:
          type: string
          format: uuid
          title: Share Id
        shared_with:
          $ref: '#/components/schemas/UserSummary'
        permission:
          $ref: '#/components/schemas/app__schemas__share__SharePermission'
        include_pages:
          type: boolean
          title: Include Pages
        shared_at:
          type: string
          format: date-time
          title: Shared At
      type: object
      required:
      - share_id
      - shared_with
      - permission
      - include_pages
      - shared_at
      title: MyFolderShareInfo
      description: A share I created for one of my folders.
    FolderShareListResponse:
      properties:
        folder_id:
          type: string
          format: uuid
          title: Folder Id
        owner:
          $ref: '#/components/schemas/UserSummary'
        shares:
          items:
            $ref: '#/components/schemas/FolderShareResponse'
          type: array
          title: Shares
      type: object
      required:
      - folder_id
      - owner
      - shares
      title: FolderShareListResponse
      description: List of shares for a folder.
    SharedPageSummary:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        title:
          type: string
          title: Title
        parent_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Parent Id
        folder_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Folder Id
        order:
          type: integer
          title: Order
          default: 0
        root_path:
          anyOf:
          - type: string
          - type: 'null'
          title: Root Path
        repo_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Repo Url
        owner:
          $ref: '#/components/schemas/UserSummary'
        permission:
          $ref: '#/components/schemas/app__schemas__share__SharePermission'
        shared_at:
          type: string
          format: date-time
          title: Shared At
        organization:
          anyOf:
          - $ref: '#/components/schemas/SharedOrganization'
          - type: 'null'
      type: object
      required:
      - id
      - title
      - owner
      - permission
      - shared_at
      title: SharedPageSummary
      description: Page shared with current user.
    OrgShareRequest:
      properties:
        permission:
          $ref: '#/components/schemas/app__schemas__share__SharePermission'
          default: view
      type: object
      title: OrgShareRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    PageShareListResponse:
      properties:
        page_id:
          type: string
          format: uuid
          title: Page Id
        owner:
          $ref: '#/components/schemas/UserSummary'
        shares:
          items:
            $ref: '#/components/schemas/PageShareResponse'
          type: array
          title: Shares
      type: object
      required:
      - page_id
      - owner
      - shares
      title: PageShareListResponse
      description: List of shares for a page.
    FolderShareCreate:
      properties:
        email:
          type: string
          format: email
          title: Email
        permission:
          $ref: '#/components/schemas/app__schemas__share__SharePermission'
          default: view
        include_pages:
          type: boolean
          title: Include Pages
          default: true
      type: object
      required:
      - email
      title: FolderShareCreate
      description: Create a folder share by email.
    FolderShareResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        folder_id:
          type: string
          format: uuid
          title: Folder Id
        shared_with:
          $ref: '#/components/schemas/UserSummary'
        permission:
          $ref: '#/components/schemas/app__schemas__share__SharePermission'
        include_pages:
          type: boolean
          title: Include Pages
        created_by:
          type: string
          format: uuid
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - folder_id
      - shared_with
      - permission
      - include_pages
      - created_by
      - created_at
      title: FolderShareResponse
      description: Folder share response with user details.
    MyPageShareInfo:
      properties:
        share_id:
          type: string
          format: uuid
          title: Share Id
        shared_with:
          $ref: '#/components/schemas/UserSummary'
        permission:
          $ref: '#/components/schemas/app__schemas__share__SharePermission'
        shared_at:
          type: string
          format: date-time
          title: Shared At
      type: object
      required:
      - share_id
      - shared_with
      - permission
      - shared_at
      title: MyPageShareInfo
      description: A share I created for one of my pages.
    MySharedPage:
      properties:
        page_id:
          type: string
          format: uuid
          title: Page Id
        page_title:
          type: string
          title: Page Title
        shares:
          items:
            $ref: '#/components/schemas/MyPageShareInfo'
          type: array
          title: Shares
      type: object
      required:
      - page_id
      - page_title
      - shares
      title: MySharedPage
      description: A page I own that is shared with others.
    MySharesResponse:
      properties:
        pages:
          items:
            $ref: '#/components/schemas/MySharedPage'
          type: array
          title: Pages
        folders:
          items:
            $ref: '#/components/schemas/MySharedFolder'
          type: array
          title: Folders
        total_page_shares:
          type: integer
          title: Total Page Shares
        total_folder_shares:
          type: integer
          title: Total Folder Shares
      type: object
      required:
      - pages
      - folders
      - total_page_shares
      - total_folder_shares
      title: MySharesResponse
      description: All resources I've shared with others.
    app__schemas__share__SharePermission:
      type: string
      enum:
      - view
      - edit
      - admin
      title: SharePermission
      description: Permission levels for shared resources.
    PageShareResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        page_id:
          type: string
          format: uuid
          title: Page Id
        shared_with:
          $ref: '#/components/schemas/UserSummary'
        permission:
          $ref: '#/components/schemas/app__schemas__share__SharePermission'
        created_by:
          type: string
          format: uuid
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
      - id
      - page_id
      - shared_with
      - permission
      - created_by
      - created_at
      title: PageShareResponse
      description: Page share response with user details.
    SharedOrganization:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
      - id
      - name
      title: SharedOrganization
    MySharedFolder:
      properties:
        folder_id:
          type: string
          format: uuid
          title: Folder Id
        folder_name:
          type: string
          title: Folder Name
        shares:
          items:
            $ref: '#/components/schemas/MyFolderShareInfo'
          type: array
          title: Shares
      type: object
      required:
      - folder_id
      - folder_name
      - shares
      title: MySharedFolder
      description: A folder I own that is shared with others.
    SharedWithMeResponse:
      properties:
        pages:
          items:
            $ref: '#/components/schemas/SharedPageSummary'
          type: array
          title: Pages
        folders:
          items:
            $ref: '#/components/schemas/SharedFolderSummary'
          type: array
          title: Folders
      type: object
      required:
      - pages
      - folders
      title: SharedWithMeResponse
      description: All resources shared with current user.
    PageShareCreate:
      properties:
        email:
          type: string
          format: email
          title: Email
        permission:
          $ref: '#/components/schemas/app__schemas__share__SharePermission'
          default: view
        scope:
          $ref: '#/components/schemas/ShareScope'
          default: single
      type: object
      required:
      - email
      title: PageShareCreate
      description: Create a page share by email.
    ShareScope:
      type: string
      enum:
      - single
      - with_children
      - folder
      title: ShareScope
      description: Scope of sharing for pages.
    UserSummary:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        email:
          type: string
          title: Email
      type: object
      required:
      - id
      - email
      title: UserSummary
      description: Minimal user info for display in shares.
    SharedFolderSummary:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        root_path:
          anyOf:
          - type: string
          - type: 'null'
          title: Root Path
        git_remote:
          anyOf:
          - type: string
          - type: 'null'
          title: Git Remote
        owner:
          $ref: '#/components/schemas/UserSummary'
        permission:
          $ref: '#/components/schemas/app__schemas__share__SharePermission'
        include_pages:
          type: boolean
          title: Include Pages
        shared_at:
          type: string
          format: date-time
          title: Shared At
        organization:
          anyOf:
          - $ref: '#/components/schemas/SharedOrganization'
          - type: 'null'
      type: object
      required:
      - id
      - name
      - owner
      - permission
      - include_pages
      - shared_at
      title: SharedFolderSummary
      description: Folder shared with current user.
    PageShareUpdate:
      properties:
        permission:
          $ref: '#/components/schemas/app__schemas__share__SharePermission'
      type: object
      required:
      - permission
      title: PageShareUpdate
      description: Update a page share permission.
    FolderShareUpdate:
      properties:
        permission:
          anyOf:
          - $ref: '#/components/schemas/app__schemas__share__SharePermission'
          - type: 'null'
        include_pages:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Include Pages
      type: object
      title: FolderShareUpdate
      description: Update a folder share.
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- ctlsurf-com-openapi.json
- ctlsurf-com-openapi.yml