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

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

200

success

{
  "code": 200,
  "data": {
    "status_cd": "1",
    "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"
        }
      ]
    }
  },
  "timestamp": 1763446641000,
  "transaction_id": "0ca94d55-c0ab-452f-9d28-e0f9509d1df4"
}

Response body schema

View response body schema

Response schema

For successful responses, this reference describes the GSTN payload at data.data.

View Excel field reference

Headers

authorization · string · required

GST taxpayer access token.

x-api-version · string · default: 1.0.0

API version.

x-api-key · string · required

API key for identification.

Path Parameters

year · string · required

Return period year.

Example:

"2024"

month · string · required

Return period month.

Example:

"05"

Query Parameters

return_type · string

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.

Option 1

Option 2

A GSTN success or GSTN business-failure response. Both variants use HTTP 200.

code · enum<integer> · required

The HTTP status code reported in the response body.

Available options: 200

Example:

200

timestamp · integer<int64> · required

The response timestamp in Unix epoch milliseconds.

Example:

1763446641000

transaction_id · string · required

The transaction identifier used to trace the request.

Example:

"41bb8041-fb83-4654-8d75-85a19f329158"

data · object · required

The GSTN success wrapper.

Show child attributes