Nextcloud Autocomplete API

openapi: 3.1.0
info:
  title: Nextcloud OCS Autocomplete API
  version: '2'
  description: 'Open Collaboration Services (OCS) REST API for a Nextcloud server. Exposes user, group, capability, share, autocomplete, and DAV-direct-link endpoints. All requests must include the `OCS-APIRequest: true` header. Authentication is Basic Auth (username with password or app token), an OIDC Bearer token, or a valid session cookie. Responses are returned as XML by default and as JSON when `Accept: application/json` is sent (or `format=json` is appended).'
  contact:
    name: Nextcloud Developer Documentation
    url: https://docs.nextcloud.com/server/latest/developer_manual/
servers:
- url: https://your-nextcloud.example
  description: A Nextcloud server (replace host)
  variables:
    host:
      default: your-nextcloud.example
security:
- BasicAuth: []
- BearerAuth: []
tags:
- name: Autocomplete
paths:
  /ocs/v2.php/core/autocomplete/get:
    get:
      tags:
      - Autocomplete
      summary: Auto-complete user, group, email, or federated search
      parameters:
      - $ref: '#/components/parameters/OcsApiRequest'
      - name: search
        in: query
        required: true
        schema:
          type: string
      - name: itemType
        in: query
        required: false
        schema:
          type: string
      - name: itemId
        in: query
        required: false
        schema:
          type: string
      - name: shareTypes
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            description: Share type enum (0=user, 1=group, 4=email, 6=federated, 7=circle, 9=guest, 10=conversation).
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: format
        in: query
        required: false
        schema:
          type: string
          enum:
          - json
          - xml
      responses:
        '200':
          description: OCS response containing autocomplete matches
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OcsEnvelope'
components:
  schemas:
    OcsEnvelope:
      type: object
      description: Standard OCS response envelope
      properties:
        ocs:
          type: object
          properties:
            meta:
              type: object
              properties:
                status:
                  type: string
                  examples:
                  - ok
                statuscode:
                  type: integer
                message:
                  type: string
            data:
              description: Endpoint-specific payload
              oneOf:
              - type: object
                additionalProperties: true
              - type: array
                items: {}
              - type: string
  parameters:
    OcsApiRequest:
      name: OCS-APIRequest
      in: header
      required: true
      schema:
        type: string
        enum:
        - 'true'
      description: Required header for all OCS API requests
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: Username + password or username + app token
    BearerAuth:
      type: http
      scheme: bearer
      description: OIDC bearer token issued by an external identity provider
externalDocs:
  description: Nextcloud OCS API overview
  url: https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-api-overview.html