Skip to main content
POST
india.gst.filings.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
gstin
string
required

Taxpayer GSTIN, including a sole proprietor's tax identifier.

Required string length: 1 - 15
Pattern: ^[0-9]{2}[A-Z]{5}[0-9]{4}[A-Z][1-9A-Z][Z1-9A-J][0-9A-Z]$
financialYear
string
required

Financial year as YYYY-YY.

Required string length: 1 - 7
Pattern: ^20[0-9]{2}-[0-9]{2}$
form
enum<string>

GST return form. A source declines forms whose selected operation is not published.

Available options:
GSTR1,
GSTR1A,
GSTR2,
GSTR2A,
GSTR2B,
GSTR3,
GSTR3B,
GSTR4,
GSTR4A,
GSTR4ANNUAL,
GSTR5,
GSTR6,
GSTR6A,
GSTR7,
GSTR8,
GSTR9,
GSTR9A,
GSTR9C,
CMP08,
ITC03,
ITC04,
GSTR2X
limit
number

Rows per page, at most 100. Default 10.

Required range: x >= 1
cursor
string

Opaque continuation returned by this operation.

Required string length: 1 - 2048

Response

The result

results
object[]
required

Taxpayer filing history; no compliance verdict.

nextCursor
string

Next page continuation.

Required string length: 1 - 2048