How to read data using the REST API

We have seen updating data using the REST API in the previous post.

Let’s retrieve the data now using the REST API. Either you can use the of the resource or the arcql filter. In this post, we will use to retrieve the data.

Data can be retrieved using the GET method. Here is a sample endpoint to retrieve the data.


The endpoint rest/v1/ is appended with the type and of the object. Here, our data type is StudentMedicalRecord and 01FTDB1JQQEKZ5D4PZ5D3W1PMJ is the object. Replace these two values with your own data type and values.

Here is the sample cURL request.


curl --location --request GET '' \
--header 'hypi-domain:' \
--header 'content-type: application/json' \
--header 'authorization: Auth_Key'

***Replace url, hypi-domain, authorization with your own set of values.

Check the Read Data with GET - 1 POSTMAN collection for the data retrieval request in different programming languages! Click </> and choose the programming language of your choice.
Run in Postman