DHIS2 Api/v2 API

The api/v2 API from DHIS2 — 17 operation(s) for api/v2.

GitHub OpenAPI

Operations 22

GET /api/v2/apps Get api V2Apps #
POST /api/v2/apps Post api V2Apps #
GET /api/v2/key Get api V2Key #
POST /api/v2/key Post api V2Key #
DELETE /api/v2/key Delete api V2Key #
GET /api/v2/me Get api V2Me #
GET /api/v2/organisations Get api V2Organisations #
POST /api/v2/organisations Post api V2Organisations #
GET /api/v2/appVersions/{appVersionId} Get api V2Appversions appversionid #
GET /api/v2/organisations/{orgIdOrSlug} Get api V2Organisations orgidorslug #
GET /api/v2/apps/{appId}/changelog Get api V2Apps appid changelog #
GET /api/v2/apps/{appId}/channels Get api V2Apps appid channels #
GET /api/v2/apps/{appId}/versions Get api V2Apps appid versions #
GET /api/v2/apps/{appId}/download/{appSlug}_{version}.zip Get api V2Apps appid download appslug versionzip #
POST /api/v2/channels Post api V2Channels #
POST /api/v2/organisations/invitation/{token} Post api V2Organisations invitation token #
POST /api/v2/organisations/{orgId}/invitation Post api V2Organisations orgid invitation #
POST /api/v2/organisations/{orgId}/user Post api V2Organisations orgid user #
DELETE /api/v2/organisations/{orgId}/user Delete api V2Organisations orgid user #
DELETE /api/v2/channels/{uuid} Delete api V2Channels uuid #
PUT /api/v2/channels/{id} Put api V2Channels id #
PATCH /api/v2/organisations/{orgId} Patch api V2Organisations orgid #

Specifications

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/dhis2:dhis2-api-v2-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

dhis2-api-v2-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: DHIS-2 App Hub API Documentation Api/v2 API
  version: 0.0.1
  description: .
servers:
- url: https://apps.dhis2.org/
tags:
- name: api/v2
paths:
  /api/v2/apps:
    get:
      operationId: getApiV2Apps
      parameters:
      - description: Filter by channel
        name: channels
        in: query
        schema:
          type: string
          default:
          - stable
      - description: Filter by core app
        name: core
        in: query
        schema:
          type: string
      - description: Filter by app type
        name: types
        in: query
        schema:
          type: string
          default:
          - APP
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Get api V2Apps
      x-summary-source: derived
    post:
      operationId: postApiV2Apps
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                app:
                  type: string
      summary: Post api V2Apps
      x-summary-source: derived
  /api/v2/key:
    get:
      operationId: getApiV2Key
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Get api V2Key
      x-summary-source: derived
    post:
      operationId: postApiV2Key
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Post api V2Key
      x-summary-source: derived
    delete:
      operationId: deleteApiV2Key
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Delete api V2Key
      x-summary-source: derived
  /api/v2/me:
    get:
      operationId: getApiV2Me
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Get api V2Me
      x-summary-source: derived
  /api/v2/organisations:
    get:
      operationId: getApiV2Organisations
      parameters:
      - description: The name of the organisation
        name: name
        in: query
        schema:
          type: string
      - description: The slug of the organisation
        name: slug
        in: query
        schema:
          type: string
      - description: The uuid of the owner of the organisations
        name: owner
        in: query
        schema:
          type: string
      - description: The uuid of the user to get organisations for
        name: user
        in: query
        schema:
          type: string
      - description: The email of the organisation
        name: email
        in: query
        schema:
          type: string
      tags:
      - api/v2
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organisations'
      summary: Get api V2Organisations
      x-summary-source: derived
    post:
      operationId: postApiV2Organisations
      tags:
      - api/v2
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model10'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model9'
      summary: Post api V2Organisations
      x-summary-source: derived
  /api/v2/appVersions/{appVersionId}:
    get:
      operationId: getApiV2AppversionsAppversionid
      parameters:
      - x-format:
          guid:
            version: uuidv4
        name: appVersionId
        in: path
        required: true
        schema:
          type: string
      tags:
      - api/v2
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppVersion'
      summary: Get api V2Appversions appversionid
      x-summary-source: derived
  /api/v2/organisations/{orgIdOrSlug}:
    get:
      operationId: getApiV2OrganisationsOrgidorslug
      parameters:
      - name: orgIdOrSlug
        in: path
        required: true
        schema:
          type: string
      tags:
      - api/v2
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganisationWithUsers'
      summary: Get api V2Organisations orgidorslug
      x-summary-source: derived
  /api/v2/apps/{appId}/changelog:
    get:
      operationId: getApiV2AppsAppidChangelog
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Get api V2Apps appid changelog
      x-summary-source: derived
  /api/v2/apps/{appId}/channels:
    get:
      operationId: getApiV2AppsAppidChannels
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Get api V2Apps appid channels
      x-summary-source: derived
  /api/v2/apps/{appId}/versions:
    get:
      operationId: getApiV2AppsAppidVersions
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      tags:
      - api/v2
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model8'
                x-alternatives:
                - $ref: '#/x-alt-definitions/Model1'
                - $ref: '#/x-alt-definitions/AppVersion'
      summary: Get api V2Apps appid versions
      x-summary-source: derived
  /api/v2/apps/{appId}/download/{appSlug}_{version}.zip:
    get:
      operationId: getApiV2AppsAppidDownloadAppslug_versionzip
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      - name: appSlug
        in: path
        required: true
        schema:
          type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Get api V2Apps appid download appslug versionzip
      x-summary-source: derived
  /api/v2/channels:
    post:
      operationId: postApiV2Channels
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Post api V2Channels
      x-summary-source: derived
  /api/v2/organisations/invitation/{token}:
    post:
      operationId: postApiV2OrganisationsInvitationToken
      parameters:
      - name: token
        in: path
        required: true
        schema:
          type: string
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Post api V2Organisations invitation token
      x-summary-source: derived
  /api/v2/organisations/{orgId}/invitation:
    post:
      operationId: postApiV2OrganisationsOrgidInvitation
      parameters:
      - x-format:
          guid:
            version: uuidv4
        name: orgId
        in: path
        required: true
        schema:
          type: string
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model11'
      summary: Post api V2Organisations orgid invitation
      x-summary-source: derived
  /api/v2/organisations/{orgId}/user:
    post:
      operationId: postApiV2OrganisationsOrgidUser
      parameters:
      - x-format:
          guid:
            version: uuidv4
        name: orgId
        in: path
        required: true
        schema:
          type: string
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model12'
      summary: Post api V2Organisations orgid user
      x-summary-source: derived
    delete:
      operationId: deleteApiV2OrganisationsOrgidUser
      parameters:
      - x-format:
          guid:
            version: uuidv4
        name: orgId
        in: path
        required: true
        schema:
          type: string
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model13'
      summary: Delete api V2Organisations orgid user
      x-summary-source: derived
  /api/v2/channels/{uuid}:
    delete:
      operationId: deleteApiV2ChannelsUuid
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      summary: Delete api V2Channels uuid
      x-summary-source: derived
  /api/v2/channels/{id}:
    put:
      operationId: putApiV2ChannelsId
      tags:
      - api/v2
      responses:
        default:
          description: Successful
          content:
            application/json:
              schema:
                type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model16'
      summary: Put api V2Channels id
      x-summary-source: derived
  /api/v2/organisations/{orgId}:
    patch:
      operationId: patchApiV2OrganisationsOrgid
      parameters:
      - x-format:
          guid:
            version: uuidv4
        name: orgId
        in: path
        required: true
        schema:
          type: string
      tags:
      - api/v2
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model19'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Model18'
      summary: Patch api V2Organisations orgid
      x-summary-source: derived
components:
  schemas:
    status:
      type: string
      enum:
      - PENDING
      - NOT_APPROVED
      - APPROVED
    Model9:
      type: object
      properties:
        name:
          type: string
          maxLength: 100
        email:
          type: string
          x-format:
            email: true
      required:
      - name
    Model19:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid:
              version: uuidv4
        updatedAt:
          type: string
          format: date
        createdAt:
          type: string
          format: date
        name:
          type: string
          maxLength: 100
        email:
          type: string
          x-format:
            email: true
        description:
          type: string
        slug:
          type: string
        owner:
          type: string
          x-format:
            guid:
              version: uuidv4
        users:
          $ref: '#/components/schemas/users'
        apps:
          $ref: '#/components/schemas/apps'
    Model8:
      type: object
      properties:
        pager:
          $ref: '#/components/schemas/pager'
        result:
          $ref: '#/components/schemas/result'
    OrganisationWithUsers:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid:
              version: uuidv4
        updatedAt:
          type: string
          format: date
        createdAt:
          type: string
          format: date
        name:
          type: string
          maxLength: 100
        email:
          type: string
          x-format:
            email: true
        description:
          type: string
        slug:
          type: string
        owner:
          type: string
          x-format:
            guid:
              version: uuidv4
        users:
          $ref: '#/components/schemas/users'
        apps:
          $ref: '#/components/schemas/apps'
    Model5:
      type: object
      properties:
        type:
          type: string
        createdAt:
          type: number
        description:
          type: string
        images:
          type: string
        id:
          type: string
        app_id:
          type: string
        name:
          type: string
        organisation:
          type: string
        hasPlugin:
          type: boolean
          enum:
          - false
    pager:
      type: object
      properties:
        page:
          type: number
        pageCount:
          type: number
        pageSize:
          type: number
        total:
          type: number
    AppVersion:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid:
              version: uuidv4
        updatedAt:
          type: string
          format: date
        createdAt:
          type: string
          format: date
        appId:
          type: string
          x-format:
            guid:
              version: uuidv4
        version:
          type: string
        channel:
          type: string
        demoUrl:
          type: string
          x-format:
            uri: true
        changeSummary:
          type: string
        downloadUrl:
          type: string
          x-format:
            uri: true
        downloadCount:
          type: number
          x-constraint:
            greater: -1
        minDhisVersion:
          type: string
        maxDhisVersion:
          type: string
        slug:
          type: string
        status:
          $ref: '#/components/schemas/status'
        hasChangelog:
          type: boolean
      required:
      - channel
      - minDhisVersion
    Model12:
      type: object
      properties:
        email:
          type: string
          x-format:
            email: true
      required:
      - email
    Model13:
      type: object
      properties:
        user:
          type: string
          x-format:
            guid:
              version: uuidv4
      required:
      - user
    apps:
      type: array
      items:
        $ref: '#/components/schemas/Model5'
    User:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid:
              version: uuidv4
        updatedAt:
          type: string
          format: date
        createdAt:
          type: string
          format: date
        name:
          type: string
        email:
          type: string
    Model10:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid: true
    users:
      type: array
      items:
        $ref: '#/components/schemas/User'
    result:
      type: array
      items:
        $ref: '#/components/schemas/AppVersion'
    Organisations:
      type: array
      items:
        $ref: '#/components/schemas/Organisation'
    Model18:
      type: object
      properties:
        name:
          type: string
          maxLength: 100
        email:
          type: string
          x-format:
            email: true
        owner:
          type: string
          x-format:
            guid:
              version: uuidv4
        description:
          type: string
    Model16:
      type: object
      properties:
        name:
          type: string
      required:
      - name
    Organisation:
      type: object
      properties:
        id:
          type: string
          x-format:
            guid:
              version: uuidv4
        updatedAt:
          type: string
          format: date
        createdAt:
          type: string
          format: date
        name:
          type: string
          maxLength: 100
        email:
          type: string
          x-format:
            email: true
        description:
          type: string
        slug:
          type: string
        owner:
          type: string
          x-format:
            guid:
              version: uuidv4
        apps:
          $ref: '#/components/schemas/apps'
    Model11:
      type: object
      properties:
        email:
          type: string
          x-format:
            email: true
        skipSend:
          type: boolean
          default: false
      required:
      - email
x-alt-definitions:
  pager:
    type: object
    properties:
      page:
        type: number
      pageCount:
        type: number
      pageSize:
        type: number
      total:
        type: number
  status:
    type: string
    enum:
    - PENDING
    - NOT_APPROVED
    - APPROVED
  AppVersion:
    type: object
    properties:
      id:
        type: string
        x-format:
          guid:
            version: uuidv4
      updatedAt:
        type: string
        format: date
      createdAt:
        type: string
        format: date
      appId:
        type: string
        x-format:
          guid:
            version: uuidv4
      version:
        type: string
      channel:
        type: string
      demoUrl:
        type: string
        x-format:
          uri: true
      changeSummary:
        type: string
      downloadUrl:
        type: string
        x-format:
          uri: true
      downloadCount:
        type: number
        x-constraint:
          greater: -1
      minDhisVersion:
        type: string
      maxDhisVersion:
        type: string
      slug:
        type: string
      status:
        $ref: '#/x-alt-definitions/status'
      hasChangelog:
        type: boolean
    required:
    - channel
    - minDhisVersion
  result:
    type: array
    items:
      $ref: '#/x-alt-definitions/AppVersion'
  Model1:
    type: object
    properties:
      pager:
        $ref: '#/x-alt-definitions/pager'
      result:
        $ref: '#/x-alt-definitions/result'