# API call to list all data elements within a dataset

**URL:** <https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529>\
**Category:** Support - Assistance technique\
**Created:** [17 August 2017 12:25 UTC](https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529 "2017-08-17T12:25:45Z")\
**Posts on this page:** 10\
**Page:** 1

<div class="post-metadata">

**Author:** ![Shurajit\_Dutta](https://dhis2.b-cdn.net/user_avatar/community.dhis2.org/shurajit_dutta/32/31781_2.png) [@Shurajit\_Dutta](https://community.dhis2.org/u/Shurajit_Dutta)\
**Post date:** [17 August 2017 12:25 UTC](https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529/1 "2017-08-17T12:25:45Z")

</div>

Hi everyone,

Can someone share with me the API call to list all data elements within a dataset, perhaps the uid and name? Though if someone has something already that provides more fields that would also be great.

Thanks,

Nick

---

<div class="post-metadata">

**Author:** ![GROUT\_Lise](https://dhis2.b-cdn.net/letter_avatar_proxy/v4/letter/g/ac8455/32.png) [@GROUT\_Lise](https://community.dhis2.org/u/GROUT_Lise)\
**Post date:** [17 August 2017 12:29 UTC](https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529/2 "2017-08-17T12:29:00Z")

</div>

We would be also very happy of being able to do this, adding description field.

Lise.

> **···**
>
> **From:** Dhis2-users [[mailto:dhis2-users-bounces+groutl=who.int@lists.launchpad.net](mailto:dhis2-users-bounces+groutl=who.int@lists.launchpad.net)] **On Behalf Of** Shurajit Dutta  
> **Sent:** 17 August 2017 14:26  
> **To:** dhis1-users  
> **Subject:** [Dhis2-users] API call to list all data elements within a dataset
> 
> Hi everyone,
> 
> Can someone share with me the API call to list all data elements within a dataset, perhaps the uid and name? Though if someone has something already that provides more fields that would also be great.
> 
> Thanks,
> 
> Nick

---

<div class="post-metadata">

**Author:** ![Vladimer\_Shioshvili](https://dhis2.b-cdn.net/user_avatar/community.dhis2.org/vladimer_shioshvili/32/39487_2.png) [@Vladimer\_Shioshvili](https://community.dhis2.org/u/Vladimer_Shioshvili)\
**Post date:** [17 August 2017 12:30 UTC](https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529/3 "2017-08-17T12:30:53Z")

</div>

This should get you started:

api/dataElements?filter=dataSets.id:eq:DATASET\_UID

> **···**
>
> On Thu, Aug 17, 2017 at 8:26 AM Shurajit Dutta [shurajitdutta@gmail.com](mailto:shurajitdutta@gmail.com) wrote:
> 
> > Hi everyone,
> 
> > 
> 
> > Can someone share with me the API call to list all data elements within a dataset, perhaps the uid and name? Though if someone has something already that provides more fields that would also be great.
> 
> > 
> 
> > Thanks,
> 
> > Nick
> 
> > * * *
> > 
> > Mailing list: [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > Post to : [dhis2-users@lists.launchpad.net](mailto:dhis2-users@lists.launchpad.net)
> > 
> > Unsubscribe : [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > More help : [https://help.launchpad.net/ListHelp](https://help.launchpad.net/ListHelp)

---

<div class="post-metadata">

**Author:** ![jason](https://dhis2.b-cdn.net/user_avatar/community.dhis2.org/jason/32/32739_2.png) [@jason](https://community.dhis2.org/u/jason)\
**Post date:** [17 August 2017 12:34 UTC](https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529/4 "2017-08-17T12:34:37Z")

</div>

In later versions of DHIS2, it would be something like this I think

[https://play.dhis2.org/dev/api/dataSets/lyLU2wR22tC?fields=dataSetElements[dataElement[id,name,description]]](https://play.dhis2.org/dev/api/dataSets/lyLU2wR22tC?fields=dataSetElements%5BdataElement%5Bid,name,description%5D%5D)

> **···**
>
> On Thu, Aug 17, 2017 at 2:30 PM, Vladimer Shioshvili [vshioshvili@gmail.com](mailto:vshioshvili@gmail.com) wrote:
> 
> > This should get you started:
> 
> > 
> 
> > 
> 
> > api/dataElements?filter=dataSets.id:eq:DATASET\_UID
> 
> > On Thu, Aug 17, 2017 at 8:26 AM Shurajit Dutta [shurajitdutta@gmail.com](mailto:shurajitdutta@gmail.com) wrote:
> 
> > > Hi everyone,
> 
> > >
> 
> > > Can someone share with me the API call to list all data elements within a dataset, perhaps the uid and name? Though if someone has something already that provides more fields that would also be great.
> 
> > >
> 
> > > Thanks,
> 
> > > Nick
> 
> > > * * *
> > > 
> > > Mailing list: [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > > 
> > > Post to : [dhis2-users@lists.launchpad.net](mailto:dhis2-users@lists.launchpad.net)
> > > 
> > > Unsubscribe : [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > > 
> > > More help : [https://help.launchpad.net/ListHelp](https://help.launchpad.net/ListHelp)
> 
> > * * *
> > 
> > Mailing list: [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > Post to : [dhis2-users@lists.launchpad.net](mailto:dhis2-users@lists.launchpad.net)
> > 
> > Unsubscribe : [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > More help : [https://help.launchpad.net/ListHelp](https://help.launchpad.net/ListHelp)
> 
> –
> 
> Jason P. Pickering  
> email: [jason.p.pickering@gmail.com](mailto:jason.p.pickering@gmail.com)  
> tel:+46764147049

---

<div class="post-metadata">

**Author:** ![Shurajit\_Dutta](https://dhis2.b-cdn.net/user_avatar/community.dhis2.org/shurajit_dutta/32/31781_2.png) [@Shurajit\_Dutta](https://community.dhis2.org/u/Shurajit_Dutta)\
**Post date:** [17 August 2017 12:38 UTC](https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529/5 "2017-08-17T12:38:34Z")

</div>

Great, thanks both. Using Jason’s for later versions is working well.

Nick

> **···**
>
> On Thu, Aug 17, 2017 at 2:34 PM, Jason Pickering [jason.p.pickering@gmail.com](mailto:jason.p.pickering@gmail.com) wrote:
> 
> > In later versions of DHIS2, it would be something like this I think
> 
> > [https://play.dhis2.org/dev/api/dataSets/lyLU2wR22tC?fields=dataSetElements[dataElement[id,name,description]]](https://play.dhis2.org/dev/api/dataSets/lyLU2wR22tC?fields=dataSetElements%5BdataElement%5Bid,name,description%5D%5D)
> 
> –
> 
> On Thu, Aug 17, 2017 at 2:30 PM, Vladimer Shioshvili [vshioshvili@gmail.com](mailto:vshioshvili@gmail.com) wrote:
> 
> > This should get you started:
> 
> > 
> 
> > 
> 
> > api/dataElements?filter=dataSets.id:eq:DATASET\_UID
> 
> > On Thu, Aug 17, 2017 at 8:26 AM Shurajit Dutta [shurajitdutta@gmail.com](mailto:shurajitdutta@gmail.com) wrote:
> 
> > > Hi everyone,
> 
> > >
> 
> > > Can someone share with me the API call to list all data elements within a dataset, perhaps the uid and name? Though if someone has something already that provides more fields that would also be great.
> 
> > >
> 
> > > Thanks,
> 
> > > Nick
> 
> > > * * *
> > > 
> > > Mailing list: [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > > 
> > > Post to : [dhis2-users@lists.launchpad.net](mailto:dhis2-users@lists.launchpad.net)
> > > 
> > > Unsubscribe : [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > > 
> > > More help : [https://help.launchpad.net/ListHelp](https://help.launchpad.net/ListHelp)
> 
> > * * *
> > 
> > Mailing list: [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > Post to : [dhis2-users@lists.launchpad.net](mailto:dhis2-users@lists.launchpad.net)
> > 
> > Unsubscribe : [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > More help : [https://help.launchpad.net/ListHelp](https://help.launchpad.net/ListHelp)
> 
> Jason P. Pickering  
> email: [jason.p.pickering@gmail.com](mailto:jason.p.pickering@gmail.com)  
> tel:+46764147049
> 
> –
> 
> Shurajit Dutta  
> Health Information Consultant

---

<div class="post-metadata">

**Author:** ![Knut\_Staring](https://dhis2.b-cdn.net/user_avatar/community.dhis2.org/knut_staring/32/32549_2.png) [@Knut\_Staring](https://community.dhis2.org/u/Knut_Staring)\
**Post date:** [17 August 2017 12:39 UTC](https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529/6 "2017-08-17T12:39:32Z")

</div>

As JSON:

[https://play.dhis2.org/dev/api/dataSets/lyLU2wR22tC.json?fields=dataSetElements[dataElement[id,name,description]]](https://play.dhis2.org/dev/api/dataSets/lyLU2wR22tC.json?fields=dataSetElements%5BdataElement%5Bid,name,description%5D%5D)

> **···**
>
> On Thu, Aug 17, 2017 at 2:38 PM, Shurajit Dutta [shurajitdutta@gmail.com](mailto:shurajitdutta@gmail.com) wrote:
> 
> > Great, thanks both. Using Jason’s for later versions is working well.
> 
> > 
> 
> > Nick
> 
> > * * *
> > 
> > Mailing list: [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > Post to : [dhis2-users@lists.launchpad.net](mailto:dhis2-users@lists.launchpad.net)
> > 
> > Unsubscribe : [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > More help : [https://help.launchpad.net/ListHelp](https://help.launchpad.net/ListHelp)
> 
> –
> 
> On Thu, Aug 17, 2017 at 2:34 PM, Jason Pickering [jason.p.pickering@gmail.com](mailto:jason.p.pickering@gmail.com) wrote:
> 
> > In later versions of DHIS2, it would be something like this I think
> 
> > [https://play.dhis2.org/dev/api/dataSets/lyLU2wR22tC?fields=dataSetElements[dataElement[id,name,description]]](https://play.dhis2.org/dev/api/dataSets/lyLU2wR22tC?fields=dataSetElements%5BdataElement%5Bid,name,description%5D%5D)
> 
> Shurajit Dutta  
> Health Information Consultant
> 
> –
> 
> On Thu, Aug 17, 2017 at 2:30 PM, Vladimer Shioshvili [vshioshvili@gmail.com](mailto:vshioshvili@gmail.com) wrote:
> 
> > This should get you started:
> 
> > 
> 
> > 
> 
> > api/dataElements?filter=dataSets.id:eq:DATASET\_UID
> 
> > On Thu, Aug 17, 2017 at 8:26 AM Shurajit Dutta [shurajitdutta@gmail.com](mailto:shurajitdutta@gmail.com) wrote:
> 
> > > Hi everyone,
> 
> > >
> 
> > > Can someone share with me the API call to list all data elements within a dataset, perhaps the uid and name? Though if someone has something already that provides more fields that would also be great.
> 
> > >
> 
> > > Thanks,
> 
> > > Nick
> 
> > > * * *
> > > 
> > > Mailing list: [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > > 
> > > Post to : [dhis2-users@lists.launchpad.net](mailto:dhis2-users@lists.launchpad.net)
> > > 
> > > Unsubscribe : [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > > 
> > > More help : [https://help.launchpad.net/ListHelp](https://help.launchpad.net/ListHelp)
> 
> > * * *
> > 
> > Mailing list: [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > Post to : [dhis2-users@lists.launchpad.net](mailto:dhis2-users@lists.launchpad.net)
> > 
> > Unsubscribe : [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > More help : [https://help.launchpad.net/ListHelp](https://help.launchpad.net/ListHelp)
> 
> Jason P. Pickering  
> email: [jason.p.pickering@gmail.com](mailto:jason.p.pickering@gmail.com)  
> tel:+46764147049
> 
> –
> 
> Knut Staring
> 
> Dept. of Informatics, University of Oslo
> 
> Norway: +4791880522
> 
> Skype: knutstar
> 
> [http://dhis2.org](http://dhis2.org)

---

<div class="post-metadata">

**Author:** ![akashjindal](https://dhis2.b-cdn.net/user_avatar/community.dhis2.org/akashjindal/32/99_2.png) [@akashjindal](https://community.dhis2.org/u/akashjindal)\
**Post date:** [17 August 2017 12:45 UTC](https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529/7 "2017-08-17T12:45:02Z")

</div>

Hi Nick,

I used this one to get the same:

[/api/dataElements.json?filter=dataSetElements.dataSet.id:eq:Xd0ePcEz1nx&fields=description,id,displayName&paging=false](http://www.google.com/url?q=http%3A%2F%2Fuphmis.in%2Fuphmis%2Fapi%2FdataElements.json%3Ffilter%3DdataSetElements.dataSet.id%3Aeq%3AXd0ePcEz1nx%26fields%3Ddescription%2Cid%2CdisplayName%26paging%3Dfalse&sa=D&sntz=1&usg=AFQjCNHSjaWAxe50AP2gHN4lfYt-Gwv60w)

Regards

Akash Jindal

> **···**
>
> On Thu, Aug 17, 2017 at 5:55 PM, Shurajit Dutta [shurajitdutta@gmail.com](mailto:shurajitdutta@gmail.com) wrote:
> 
> > Hi everyone,
> 
> > 
> 
> > Can someone share with me the API call to list all data elements within a dataset, perhaps the uid and name? Though if someone has something already that provides more fields that would also be great.
> 
> > 
> 
> > Thanks,
> 
> > Nick
> 
> > * * *
> > 
> > Mailing list: [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > Post to : [dhis2-users@lists.launchpad.net](mailto:dhis2-users@lists.launchpad.net)
> > 
> > Unsubscribe : [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > More help : [https://help.launchpad.net/ListHelp](https://help.launchpad.net/ListHelp)

---

<div class="post-metadata">

**Author:** ![Vladimer\_Shioshvili](https://dhis2.b-cdn.net/user_avatar/community.dhis2.org/vladimer_shioshvili/32/39487_2.png) [@Vladimer\_Shioshvili](https://community.dhis2.org/u/Vladimer_Shioshvili)\
**Post date:** [17 August 2017 12:50 UTC](https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529/8 "2017-08-17T12:50:38Z")

</div>

Jason is right, my suggestion does not work in later versions. Akash’s gives you what I was trying to get:

[https://play.dhis2.org/dev/api/dataElements?filter=dataSetElements.dataSet.id:eq:lyLU2wR22tC&fields=id,name,description&paging=false](https://play.dhis2.org/dev/api/dataElements?filter=dataSetElements.dataSet.id:eq:lyLU2wR22tC&fields=id,name,description&paging=false)

> **···**
>
> On Thu, Aug 17, 2017 at 5:55 PM, Shurajit Dutta [shurajitdutta@gmail.com](mailto:shurajitdutta@gmail.com) wrote:
> 
> > Hi everyone,
> 
> > 
> 
> > Can someone share with me the API call to list all data elements within a dataset, perhaps the uid and name? Though if someone has something already that provides more fields that would also be great.
> 
> > 
> 
> > Thanks,
> 
> > Nick
> 
> > * * *
> > 
> > Mailing list: [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > Post to : [dhis2-users@lists.launchpad.net](mailto:dhis2-users@lists.launchpad.net)
> > 
> > Unsubscribe : [https://launchpad.net/~dhis2-users](https://launchpad.net/~dhis2-users)
> > 
> > More help : [https://help.launchpad.net/ListHelp](https://help.launchpad.net/ListHelp)

---

<div class="post-metadata">

**Author:** ![j.afo](https://dhis2.b-cdn.net/letter_avatar_proxy/v4/letter/j/58956e/32.png) [@j.afo](https://community.dhis2.org/u/j.afo)\
**Post date:** [3 June 2024 08:41 UTC](https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529/9 "2024-06-03T08:41:37Z")

</div>

Hi @jason @Vladimer_Shioshvili.

Please can I know if this link returns all the data elements in that data set?

---

<div class="post-metadata">

**Author:** ![dkusiima](https://dhis2.b-cdn.net/user_avatar/community.dhis2.org/dkusiima/32/28239_2.png) [@dkusiima](https://community.dhis2.org/u/dkusiima)\
**Post date:** [5 May 2025 05:36 UTC](https://community.dhis2.org/t/api-call-to-list-all-data-elements-within-a-dataset/4529/10 "2025-05-05T05:36:37Z")

</div>

Hi @j.afo yes it did return the data elements in the selected dataset
