Track Returns
curl --request GET \
--url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track \
--header 'authorization: <authorization>' \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track"
headers = {
"authorization": "<authorization>",
"x-api-key": "<x-api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {authorization: '<authorization>', 'x-api-key': '<x-api-key>'}
};
fetch('https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"authorization: <authorization>",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<authorization>")
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track")
.header("authorization", "<authorization>")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"code": 200,
"data": {
"data": {
"EFiledlist": [
{
"arn": "AA010143556585B",
"ret_prd": "022017",
"mof": "ONLINE",
"dof": "08-02-2017",
"rtntype": "GSTR2",
"status": "Filed",
"valid": "Y"
},
{
"arn": "AA010143556585B",
"ret_prd": "022017",
"mof": "ONLINE",
"dof": "07-02-2017",
"rtntype": "GSTR1",
"status": "Filed",
"valid": "Y"
},
{
"arn": "AA010143556587A",
"ret_prd": "032017",
"mof": "ONLINE",
"dof": "07-03-2017",
"rtntype": "GSTR3",
"status": "Filed",
"valid": "N"
}
]
},
"status_cd": "1"
},
"timestamp": 1763446641000,
"transaction_id": "0ca94d55-c0ab-452f-9d28-e0f9509d1df4"
}Track Returns
List filed GST returns for a return period for an authenticated taxpayer.
GET
/
gst
/
compliance
/
tax-payer
/
gstrs
/
{year}
/
{month}
/
track
Track Returns
curl --request GET \
--url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track \
--header 'authorization: <authorization>' \
--header 'x-api-key: <x-api-key>'import requests
url = "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track"
headers = {
"authorization": "<authorization>",
"x-api-key": "<x-api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {authorization: '<authorization>', 'x-api-key': '<x-api-key>'}
};
fetch('https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"authorization: <authorization>",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("authorization", "<authorization>")
req.Header.Add("x-api-key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track")
.header("authorization", "<authorization>")
.header("x-api-key", "<x-api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/{year}/{month}/track")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
request["x-api-key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"code": 200,
"data": {
"data": {
"EFiledlist": [
{
"arn": "AA010143556585B",
"ret_prd": "022017",
"mof": "ONLINE",
"dof": "08-02-2017",
"rtntype": "GSTR2",
"status": "Filed",
"valid": "Y"
},
{
"arn": "AA010143556585B",
"ret_prd": "022017",
"mof": "ONLINE",
"dof": "07-02-2017",
"rtntype": "GSTR1",
"status": "Filed",
"valid": "Y"
},
{
"arn": "AA010143556587A",
"ret_prd": "032017",
"mof": "ONLINE",
"dof": "07-03-2017",
"rtntype": "GSTR3",
"status": "Filed",
"valid": "N"
}
]
},
"status_cd": "1"
},
"timestamp": 1763446641000,
"transaction_id": "0ca94d55-c0ab-452f-9d28-e0f9509d1df4"
}Response body schema
View response body schema
Headers
GST taxpayer access token.
API version.
API key for identification.
Path Parameters
Return period year.
Example:
"2024"
Return period month.
Example:
"05"
Query Parameters
Optional return type filter. Use repo-style values such as gstr-1, gstr-3b, or gstr-9.
Example:
"gstr-1"
Response
200 - application/json
200 Success. On GST-side business failure, the sandbox wrapper still returns 200 with data.status_cd = "0" and an error object.
The response is of type object.
Was this page helpful?
āI