Nextcloud

Nextcloud Users API

The Users API from Nextcloud — 2 operation(s) for users.

Documentation GitHub OpenAPI

Operations 2

GET /ocs/v1.php/cloud/users List all user IDs (admin only) #

GET /ocs/v1.php/cloud/users/{userId} Retrieve user metadata #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/nextcloud/refs/heads/main/openapi/nextcloud-users-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/nextcloud-users-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Nextcloud OCS Users 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: Users
paths:
  /ocs/v1.php/cloud/users:
    get:
      tags:
      - Users
      summary: List all user IDs (admin only)
      parameters:
      - $ref: '#/components/parameters/OcsApiRequest'
      - name: search
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
      - name: offset
        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 user IDs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OcsEnvelope'
      operationId: getOcsV1PhpCloudUsers
      x-operation-id-source: derived
  /ocs/v1.php/cloud/users/{userId}:
    get:
      tags:
      - Users
      summary: Retrieve user metadata
      parameters:
      - $ref: '#/components/parameters/OcsApiRequest'
      - name: userId
        in: path
        required: true
        schema:
          type: string
      - name: format
        in: query
        required: false
        schema:
          type: string
          enum:
          - json
          - xml
      responses:
        '200':
          description: OCS response containing user metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OcsEnvelope'
      operationId: getOcsV1PhpCloudUsersByUserId
      x-operation-id-source: derived
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