> ## Documentation Index
> Fetch the complete documentation index at: https://developer.sandbox.co.in/llms.txt
> Use this file to discover all available pages before exploring further.
# Track Returns
> List filed GST returns for a return period for an authenticated taxpayer.
#### Response body schema
#### Response schema
For successful responses, this reference describes the GSTN payload at `data.data`.
## OpenAPI
````yaml api-reference/gst/compliance/openapi.json GET /gst/compliance/tax-payer/gstrs/{year}/{month}/track
openapi: 3.0.1
info:
title: compliance
description: >-
**GST Compliance API** enables businesses to automate compliance
requirements like [Taxpayer
verification](https://developer.sandbox.co.in/reference/search-gstin-api),
[GSTR
Filing](https://developer.sandbox.co.in/reference/gst-taxpayer-authentication),
[Generating
E-Invoices](https://developer.sandbox.co.in/reference/e-invoice-authentication-api),
and [E-Way
Bills](https://developer.sandbox.co.in/reference/e-way-bill-authentication-api).We
provide these APIs from GSTN-authorised GST Suvidha Providers, handling the
encryption-decryption and signing so you don't have to handle the
complexities.
version: 1.0.0
servers:
- url: https://api.sandbox.co.in
- url: https://test-api.sandbox.co.in
security: []
tags:
- name: Public
- name: Taxpayer
- name: Taxpayer Auth
- name: Returns
- name: GSTR-1 Documents
- name: File GSTR-1
- name: GSTR-2A Documents
- name: GSTR-2B Document
- name: File GSTR-3B
- name: GSTR-4
- name: File GSTR-9
- name: Invoice Management System
- name: GSTR-1A Documents
- name: File GSTR-1A
- name: Ledgers
- name: e-Invoice
- name: Sales e-Invoices for return period
- name: Purchase e-Invoices for return period
- name: Front Office Notices
- name: Front Office
- name: AATO
- name: e-Invoice1
- name: Authentication
- name: e-Invoice12
- name: E-Way Bill
- name: E-Way Bill1
- name: Authentication1
- name: Consignor
- name: Consolidated E-Way Bill
- name: Multi-Vehicle Movement
- name: Consignee
- name: Transporter
- name: Consolidated E-Way Bill1
- name: Multi-vehicle Movement
- name: Common
paths:
/gst/compliance/tax-payer/gstrs/{year}/{month}/track:
get:
tags:
- Taxpayer
- Returns
summary: Track Returns
description: >-
List filed GST returns for a return period for an authenticated
taxpayer.
operationId: trackReturns
parameters:
- name: year
in: path
description: Return period year.
required: true
example: '2026'
schema:
type: string
example: '2024'
- name: month
in: path
description: Return period month.
required: true
example: '03'
schema:
type: string
example: '05'
- name: return_type
in: query
description: >-
Optional return type filter. Use repo-style values such as `gstr-1`,
`gstr-3b`, or `gstr-9`.
required: false
example: ''
schema:
type: string
example: gstr-1
- name: authorization
in: header
description: GST taxpayer access token.
required: true
example: '{{gsp_access_token}}'
schema:
type: string
- name: x-api-version
in: header
description: API version.
required: false
example: ''
schema:
type: string
default: 1.0.0
- name: x-api-key
in: header
description: API key for identification.
required: true
example: '{{api_key}}'
schema:
type: string
responses:
'200':
description: >-
200 Success. On GST-side business failure, the sandbox wrapper still
returns 200 with `data.status_cd = "0"` and an `error` object.
content:
application/json:
schema:
$ref: '#/components/schemas/TrackReturnsResponse'
examples:
success:
summary: Success
value:
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
record_not_found:
summary: Record Not Found
value:
code: 200
timestamp: 1782371188498
data:
status_cd: '1'
data: {}
transaction_id: 9fff47a3-15e0-4cd1-864f-7cf72338498c
headers: {}
deprecated: false
security: []
components:
schemas:
TrackReturnsResponse:
oneOf:
- $ref: '#/components/schemas/TrackReturnsSuccessResponse'
- $ref: '#/components/schemas/GstnBusinessErrorResponse'
description: >-
A GSTN success or GSTN business-failure response. Both variants use HTTP
200.
TrackReturnsSuccessResponse:
allOf:
- $ref: '#/components/schemas/TaxpayerResponseMetadata'
- type: object
required:
- data
properties:
data:
type: object
description: The GSTN success wrapper.
required:
- status_cd
- data
properties:
status_cd:
type: string
enum:
- '1'
description: GSTN success status.
example: '1'
data:
$ref: '#/components/schemas/TrackReturnsSuccessPayload'
GstnBusinessErrorResponse:
type: object
description: HTTP 200 response containing a GSTN business failure.
required:
- code
- timestamp
- transaction_id
- data
properties:
code:
type: integer
description: The HTTP status code reported in the response body.
enum:
- 200
example: 200
timestamp:
type: integer
format: int64
description: The response timestamp in Unix epoch milliseconds.
example: 1763446641000
transaction_id:
type: string
description: The transaction identifier used to trace the request.
example: 41bb8041-fb83-4654-8d75-85a19f329158
data:
type: object
description: The GSTN business-failure wrapper.
required:
- status_cd
- error
properties:
status_cd:
type: string
enum:
- '0'
description: GSTN business-failure status.
example: '0'
error:
$ref: '#/components/schemas/GstnBusinessError'
TaxpayerResponseMetadata:
type: object
description: Fields included in every taxpayer endpoint response.
required:
- code
- timestamp
- transaction_id
properties:
code:
type: integer
description: The HTTP status code reported in the response body.
enum:
- 200
example: 200
timestamp:
type: integer
format: int64
description: The response timestamp in Unix epoch milliseconds.
example: 1763446641000
transaction_id:
type: string
description: The transaction identifier used to trace the request.
example: 41bb8041-fb83-4654-8d75-85a19f329158
TrackReturnsSuccessPayload:
type: object
description: Successful GSTN payload for Track Returns.
properties:
EFiledlist:
type: array
description: The EFiledlist value returned by GSTN.
items:
type: object
properties:
arn:
type: string
description: The arn value returned by GSTN.
ret_prd:
type: string
description: The ret prd value returned by GSTN.
mof:
type: string
description: The mof value returned by GSTN.
dof:
type: string
description: The dof value returned by GSTN.
rtntype:
type: string
description: The rtntype value returned by GSTN.
status:
type: string
description: The status value returned by GSTN.
valid:
type: string
description: The valid value returned by GSTN.
GstnBusinessError:
type: object
description: A business error returned by GSTN.
required:
- error_cd
- message
properties:
error_cd:
type: string
description: The GSTN business error code.
example: RET11416
message:
type: string
description: A human-readable description of the GSTN business error.
example: No records found.
````