DHIS2 Team API
The team API from DHIS2 — 8 operation(s) for team.
The team API from DHIS2 — 8 operation(s) for team.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/dhis2:dhis2-team-api"
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.
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: 3.2.0
info:
title: Open edX Team 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: Team
paths:
/team/v0/bulk_team_membership/{course_id}:
parameters:
- name: course_id
in: path
required: true
schema:
type: string
get:
operationId: team_v0_bulk_team_membership_read
description: Download CSV with team membership data for given course run.
responses:
'200':
description: ''
tags:
- Team
summary: Team v0 bulk team membership read
x-summary-source: derived
post:
operationId: team_v0_bulk_team_membership_create
description: Process uploaded CSV to modify team memberships for given course run.
responses:
'201':
description: ''
tags:
- Team
summary: Team v0 bulk team membership create
x-summary-source: derived
/team/v0/team_membership/:
parameters: []
get:
operationId: team_v0_team_membership_list
description: GET /api/team/v0/team_membership
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/Membership'
tags:
- Team
summary: Team v0 team membership list
x-summary-source: derived
post:
operationId: team_v0_team_membership_create
description: POST /api/team/v0/team_membership
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Membership'
tags:
- Team
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Membership'
required: true
summary: Team v0 team membership create
x-summary-source: derived
/team/v0/team_membership/{team_id},{username}:
parameters:
- name: team_id
in: path
required: true
schema:
type: string
- name: username
in: path
required: true
schema:
type: string
get:
operationId: team_v0_team_membership_read
description: GET /api/team/v0/team_membership/{team_id},{username}
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Membership'
tags:
- Team
summary: Team v0 team membership read
x-summary-source: derived
delete:
operationId: team_v0_team_membership_delete
description: DELETE /api/team/v0/team_membership/{team_id},{username}
responses:
'204':
description: ''
tags:
- Team
summary: Team v0 team membership delete
x-summary-source: derived
/team/v0/teams/:
parameters: []
get:
operationId: team_v0_teams_list
description: GET /api/team/v0/teams/
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/CourseTeam'
tags:
- Team
summary: Team v0 teams list
x-summary-source: derived
post:
operationId: team_v0_teams_create
description: POST /api/team/v0/teams/
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CourseTeam'
tags:
- Team
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CourseTeam'
required: true
summary: Team v0 teams create
x-summary-source: derived
/team/v0/teams/{team_id}:
parameters:
- name: team_id
in: path
required: true
schema:
type: string
get:
operationId: team_v0_teams_read
description: Retrieves the specified resource using the RetrieveModelMixin.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CourseTeam'
tags:
- Team
summary: Team v0 teams read
x-summary-source: derived
patch:
operationId: team_v0_teams_partial_update
description: Checks for validation errors, then updates the model using the UpdateModelMixin.
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CourseTeam'
tags:
- Team
requestBody:
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/CourseTeam'
required: true
summary: Team v0 teams partial update
x-summary-source: derived
delete:
operationId: team_v0_teams_delete
description: DELETE /api/team/v0/teams/{team_id}
responses:
'204':
description: ''
tags:
- Team
summary: Team v0 teams delete
x-summary-source: derived
/team/v0/teams/{team_id}/assignments:
parameters:
- name: team_id
in: path
required: true
schema:
type: string
get:
operationId: team_v0_teams_assignments_list
description: GET v0/teams/{team_id_pattern}/assignments
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: ''
tags:
- Team
summary: Team v0 teams assignments list
x-summary-source: derived
/team/v0/topics/:
parameters: []
get:
operationId: team_v0_topics_list
description: GET /api/team/v0/topics/?course_id={course_id}
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: ''
tags:
- Team
summary: Team v0 topics list
x-summary-source: derived
/team/v0/topics/{topic_id},{course_id}:
parameters:
- name: topic_id
in: path
required: true
schema:
type: string
- name: course_id
in: path
required: true
schema:
type: string
get:
operationId: team_v0_topics_read
description: GET /api/team/v0/topics/{topic_id},{course_id}/
responses:
'200':
description: ''
tags:
- Team
summary: Team v0 topics read
x-summary-source: derived
components:
schemas:
UserMembership:
required:
- user
type: object
properties:
user:
title: User
type: string
date_joined:
title: Date joined
type: string
format: date-time
readOnly: true
last_activity_at:
title: Last activity at
type: string
format: date-time
readOnly: true
CourseTeam:
required:
- name
- description
- country
type: object
properties:
id:
title: Id
type: string
readOnly: true
minLength: 1
discussion_topic_id:
title: Discussion topic id
type: string
format: slug
pattern: ^[-a-zA-Z0-9_]+$
readOnly: true
minLength: 1
name:
title: Name
type: string
maxLength: 255
minLength: 1
course_id:
title: Course id
type: string
readOnly: true
minLength: 1
topic_id:
title: Topic id
type: string
maxLength: 255
date_created:
title: Date created
type: string
format: date-time
readOnly: true
description:
title: Description
type: string
maxLength: 300
minLength: 1
country:
title: Country
type: string
language:
title: Language
description: Optional language the team uses as ISO 639-1 code.
type: string
enum:
- aa
- ab
- af
- ak
- sq
- am
- ar
- an
- hy
- as
- av
- ae
- ay
- az
- ba
- bm
- eu
- be
- bn
- bh
- bi
- bs
- br
- bg
- my
- ca
- ch
- ce
- zh
- zh_HANS
- zh_HANT
- cu
- cv
- kw
- co
- cr
- cs
- da
- dv
- nl
- dz
- en
- eo
- et
- ee
- fo
- fj
- fi
- fr
- fy
- ff
- ka
- de
- gd
- ga
- gl
- gv
- el
- gn
- gu
- ht
- ha
- he
- hz
- hi
- ho
- hr
- hu
- ig
- is
- io
- ii
- iu
- ie
- ia
- id
- ik
- it
- jv
- ja
- kl
- kn
- ks
- kr
- kk
- km
- ki
- rw
- ky
- kv
- kg
- ko
- kj
- ku
- lo
- la
- lv
- li
- ln
- lt
- lb
- lu
- lg
- mk
- mh
- ml
- mi
- mr
- ms
- mg
- mt
- mn
- na
- nv
- nr
- nd
- ng
- ne
- nn
- nb
- 'no'
- ny
- oc
- oj
- or
- om
- os
- pa
- fa
- pi
- pl
- pt
- ps
- qu
- rm
- ro
- rn
- ru
- sg
- sa
- si
- sk
- sl
- se
- sm
- sn
- sd
- so
- st
- es
- sc
- sr
- ss
- su
- sw
- sv
- ty
- ta
- tt
- te
- tg
- tl
- th
- bo
- ti
- to
- tn
- ts
- tk
- tr
- tw
- ug
- uk
- ur
- uz
- ve
- vi
- vo
- cy
- wa
- wo
- xh
- yi
- yo
- za
- zu
last_activity_at:
title: Last activity at
type: string
format: date-time
readOnly: true
membership:
type: array
items:
$ref: '#/components/schemas/UserMembership'
readOnly: true
organization_protected:
title: Organization protected
type: boolean
Membership:
required:
- user
- team
type: object
properties:
user:
title: User
type: string
team:
title: Team
type: string
date_joined:
title: Date joined
type: string
format: date-time
readOnly: true
last_activity_at:
title: Last activity at
type: string
format: date-time
readOnly: true
securitySchemes:
Basic:
type: http
scheme: basic