DHIS2 Organizations API

The organizations API from DHIS2 — 2 operation(s) for organizations.

GitHub OpenAPI

Operations 4

GET /organizations/v0/organizations/ Organizations v0 organizations list #
GET /organizations/v0/organizations/{short_name}/ Organizations v0 organizations read #
PUT /organizations/v0/organizations/{short_name}/ We perform both Update and Create action via the PUT method #
PATCH /organizations/v0/organizations/{short_name}/ Organizations v0 organizations partial update #

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-organizations-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-organizations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Open edX Organizations API
  description: APIs for access to Open edX information
  contact:
    email: contact@academy.dhis2.org
  version: v1
servers:
- url: https://academy.dhis2.org/api
security:
- Basic: []
tags:
- name: Organizations
paths:
  /organizations/v0/organizations/:
    parameters: []
    get:
      operationId: organizations_v0_organizations_list
      description: 'Organization view to:

        - list organization data (GET .../)

        - retrieve single organization (GET .../)

        - create or update an organization via the PUT endpoint (PUT .../)'
      parameters:
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        schema:
          type: integer
      - name: page_size
        in: query
        description: Number of results to return per page.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                required:
                - count
                - results
                type: object
                properties:
                  count:
                    type: integer
                  next:
                    type:
                    - string
                    - 'null'
                    format: uri
                  previous:
                    type:
                    - string
                    - 'null'
                    format: uri
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Organization'
      tags:
      - Organizations
      summary: Organizations v0 organizations list
      x-summary-source: derived
  /organizations/v0/organizations/{short_name}/:
    parameters:
    - name: short_name
      in: path
      description: Unique, short string identifier for organization. Please do not use spaces or special characters. Only allowed special characters are period (.), hyphen (-) and underscore (_).
      required: true
      schema:
        type: string
        pattern: '[^/+]+'
    get:
      operationId: organizations_v0_organizations_read
      description: 'Organization view to:

        - list organization data (GET .../)

        - retrieve single organization (GET .../)

        - create or update an organization via the PUT endpoint (PUT .../)'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
      tags:
      - Organizations
      summary: Organizations v0 organizations read
      x-summary-source: derived
    put:
      operationId: organizations_v0_organizations_update
      summary: We perform both Update and Create action via the PUT method
      description: 'The ''active'' field may not be specified via the HTTP API, since it

        is always assumed to be True. So:

        (1) new organizations created through the API are always Active, and

        (2) existing organizations updated through the API always end up Active,

        regardless of whether or not they were previously active.'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
      tags:
      - Organizations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Organization'
        required: true
    patch:
      operationId: organizations_v0_organizations_partial_update
      description: We disable PATCH because all updates and creates should use the PUT action above.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Organization'
      tags:
      - Organizations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Organization'
        required: true
      summary: Organizations v0 organizations partial update
      x-summary-source: derived
components:
  schemas:
    Organization:
      required:
      - name
      - short_name
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        created:
          title: Created
          type: string
          format: date-time
          readOnly: true
        modified:
          title: Modified
          type: string
          format: date-time
          readOnly: true
        name:
          title: Name
          type: string
          maxLength: 255
          minLength: 1
        short_name:
          title: Short Name
          description: Unique, short string identifier for organization. Please do not use spaces or special characters. Only allowed special characters are period (.), hyphen (-) and underscore (_).
          type: string
          maxLength: 255
          minLength: 1
        description:
          title: Description
          type:
          - string
          - 'null'
        logo:
          title: Logo
          description: Please add only .PNG files for logo images. This logo will be used on certificates.
          type:
          - string
          - 'null'
          readOnly: true
          format: uri
        active:
          title: Active
          type: boolean
        logo_url:
          title: Logo url
          type: string
          minLength: 1
  securitySchemes:
    Basic:
      type: http
      scheme: basic