ClusterHack Users API

The users API from ClusterHack — 3 operation(s) for users.

GitHub OpenAPI

Operations 3

GET /api/v1/users/ Users list #
GET /api/v1/users/{id}/ Users retrieve #
POST /api/v1/users/{id}/set-active/ Users set active create #

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/clusterhack-dev:clusterhack-dev-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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

OpenAPI Specification

clusterhack-dev-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Clusterhack Dev Users API
  version: 1.3.0
  description: 'Operations tagged users across 2 of this provider''s published API definitions: clusterhack-dev-openapi-original.json, clusterhack-dev-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://clusterhack.dev
  description: Production. Not stated in the provider spec (no servers[]); the spec is served from https://clusterhack.dev/api/schema/ and its paths are rooted at /api/v1 and /geo-api.
tags:
- name: Users
paths:
  /api/v1/users/:
    get:
      operationId: users_list
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - Users
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPublicUserList'
          description: ''
        '401':
          description: 'Not authenticated. The response carries `WWW-Authenticate: Bearer realm="api"`; obtain or refresh a token and retry.'
          headers:
            WWW-Authenticate:
              description: Always `Bearer realm="api"`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '403':
          description: Authenticated, but not permitted to perform this action on this object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '429':
          description: Rate limit exceeded (see `DEFAULT_THROTTLE_RATES`). `Retry-After` gives the number of seconds to wait.
          headers:
            Retry-After:
              description: Seconds until the caller may retry.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '500':
          description: Unhandled server error.
      summary: Users list
      x-summary-source: derived
  /api/v1/users/{id}/:
    get:
      operationId: users_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this user.
        required: true
      tags:
      - Users
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicUser'
          description: ''
        '401':
          description: 'Not authenticated. The response carries `WWW-Authenticate: Bearer realm="api"`; obtain or refresh a token and retry.'
          headers:
            WWW-Authenticate:
              description: Always `Bearer realm="api"`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '403':
          description: Authenticated, but not permitted to perform this action on this object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '404':
          description: No such object, or it is not visible to you.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '429':
          description: Rate limit exceeded (see `DEFAULT_THROTTLE_RATES`). `Retry-After` gives the number of seconds to wait.
          headers:
            Retry-After:
              description: Seconds until the caller may retry.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '500':
          description: Unhandled server error.
      summary: Users retrieve
      x-summary-source: derived
  /api/v1/users/{id}/set-active/:
    post:
      operationId: users_set_active_create
      description: 'POST /api/v1/users//set-active/ — {"is_active": bool}. Staff only.


        Deactivating an account was previously reachable only through Django

        admin or the MCP tool''s direct ORM write; the API had no path at all.

        Deliberately its own action rather than a writable field on the list

        serializer: the public directory stays read-only and PII-free.


        Two guards mirror ``admin_set_user_active``: staff cannot lock

        themselves out, and one staff account cannot switch off another (ask a

        different admin, or use Django admin).'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this user.
        required: true
      tags:
      - Users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminUserSetActiveRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AdminUserSetActiveRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AdminUserSetActiveRequest'
        required: true
      security:
      - jwtAuth: []
      - tokenAuth: []
      - cookieAuth: []
      - basicAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminUserSetActive'
          description: ''
        '400':
          description: The request body failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: 'Not authenticated. The response carries `WWW-Authenticate: Bearer realm="api"`; obtain or refresh a token and retry.'
          headers:
            WWW-Authenticate:
              description: Always `Bearer realm="api"`.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '403':
          description: Authenticated, but not permitted to perform this action on this object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '404':
          description: No such object, or it is not visible to you.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '429':
          description: Rate limit exceeded (see `DEFAULT_THROTTLE_RATES`). `Retry-After` gives the number of seconds to wait.
          headers:
            Retry-After:
              description: Seconds until the caller may retry.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '500':
          description: Unhandled server error.
      summary: Users set active create
      x-summary-source: derived
components:
  schemas:
    ErrorDetail:
      type: object
      description: The body DRF returns for a handled error.
      properties:
        detail:
          type: string
          description: Human-readable explanation of the failure.
      required:
      - detail
    PaginatedPublicUserList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/PublicUser'
    AdminUserSetActive:
      type: object
      properties:
        is_active:
          type: boolean
      required:
      - is_active
    AdminUserSetActiveRequest:
      type: object
      properties:
        is_active:
          type: boolean
      required:
      - is_active
    ValidationError:
      type: object
      description: Field-keyed validation errors. Errors that belong to no single field appear under `non_field_errors`.
      additionalProperties:
        type: array
        items:
          type: string
    PublicUser:
      type: object
      description: User fields safe to expose about OTHER users — never email.
      properties:
        id:
          type: integer
          readOnly: true
        username:
          type: string
          description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
          pattern: ^[\w.@+-]+$
          maxLength: 150
        first_name:
          type: string
          maxLength: 150
        last_name:
          type: string
          maxLength: 150
      required:
      - id
      - username
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Access token from `POST /api/v1/auth/jwt/`, refreshed at `POST /api/v1/auth/jwt/refresh/`. Send as `Authorization: Bearer <access>`.'
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
x-refined-from:
- clusterhack-dev-openapi-original.json
- clusterhack-dev-openapi.yml