> ## Documentation Index
> Fetch the complete documentation index at: https://docs.diskograf.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List contributors

> Public member profiles. Members without a username, and banned members, are never returned. Private account fields — email, roles, ban state — are never included in any response.



## OpenAPI

````yaml /openapi.json get /v1/users
openapi: 3.1.0
info:
  title: Diskograf API
  description: >-
    A public, read-only REST API over the Diskograf catalogue of Malaysian
    music.


    No authentication is required and no endpoint writes. Requests are rate
    limited

    to 60 per 60 seconds per IP address.


    Every successful response is wrapped in an envelope. List endpoints return

    `{ "data": [...], "meta": { "total", "limit", "offset" } }`; detail
    endpoints

    return `{ "data": {...} }`. Errors return `{ "error": { "code", "message" }
    }`.
  version: 1.0.0
servers:
  - url: https://api.diskograf.com
    description: Production
security: []
tags:
  - name: Songs
    description: The catalogue of published songs and their credits.
  - name: Artists
    description: Performers, writers and producers, and their discographies.
  - name: Genres
    description: The genre taxonomy and the songs in each genre.
  - name: Labels
    description: Record labels and their releases.
  - name: Users
    description: Public contributor profiles. Private account fields are never returned.
  - name: Search
    description: Cross-category keyword search.
  - name: Meta
    description: Service index, statistics and health.
paths:
  /v1/users:
    get:
      tags:
        - Users
      summary: List contributors
      description: >-
        Public member profiles. Members without a username, and banned members,
        are never returned. Private account fields — email, roles, ban state —
        are never included in any response.
      operationId: getV1Users
      parameters:
        - name: q
          in: query
          schema:
            type: string
          description: Keyword search across names and usernames.
        - name: filter
          in: query
          schema:
            type: string
          description: Subset filter, for example artists only.
        - name: sort
          in: query
          schema:
            type: string
          description: Sort column.
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 80
            default: 20
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: A page of contributors.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        username:
                          type: string
                        name:
                          type: string
                        avatar_url:
                          anyOf:
                            - type: string
                            - type: 'null'
                        is_fan:
                          type: boolean
                        is_artist:
                          type: boolean
                        is_group:
                          type: boolean
                        joined_at:
                          type: string
                        contribution_count:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                      required:
                        - username
                        - name
                        - avatar_url
                        - is_fan
                        - is_artist
                        - is_group
                        - joined_at
                        - contribution_count
                  meta:
                    type: object
                    properties:
                      total:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: >-
                          Total rows matching the query, ignoring limit and
                          offset.
                      limit:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: >-
                          Page size actually applied. Bounded by
                          apiConfig.maxLimit (80).
                      offset:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: Zero-based row offset of this page.
                    required:
                      - total
                      - limit
                      - offset
                required:
                  - data
                  - meta
        '400':
          $ref: '#/components/responses/BadRequest'
components:
  responses:
    BadRequest:
      description: >-
        A query or path parameter failed validation. The message names the
        offending field.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - not_found
                      - bad_request
                      - internal_error
                  message:
                    type: string
                required:
                  - code
                  - message
            required:
              - error

````