Parent API: GST API Quickstart guide Authentication guide

GST Portal Saved User Masters

Q: What parameters and payload format are required for Get User Masters?

Requests are submitted via HTTP GET to '/all/getmasters'. Required parameters: 'email' (query parameter), 'gstin' (query parameter), 'ret_period' (header parameter), 'gst_username' (header parameter), 'state_cd' (header parameter), 'ip_address' (header parameter), 'txn' (header parameter), 'client_id' (header parameter), 'client_secret' (header parameter). No request body payload is required for this call.

Q: What response status codes and format does Get User Masters return?

For Get User Masters (GET '/all/getmasters'), responses are returned in JSON format ('application/json'). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

GEThttps://apisandbox.whitebooks.in/all/getmasters

This API is used to Get User Masters

Parameters

query parameters

emailstringrequired

gstinstringrequired

GSTIN of the taxpayer

header parameters

ret_periodstringrequired

Return Period

gst_usernamestringrequired

GST UserName

state_cdstringrequired

State Code

ip_addressstringrequired

IP Address

txnstringrequired

Transaction

client_idstringrequired

Client ID

client_secretstringrequired

Client Secret

Response

Not Found. If requested entity is not found or if requested API is not found.

Frequently Asked Questions

Requests are submitted via HTTP GET to /all/getmasters. Required parameters: email (query parameter), gstin (query parameter), ret_period (header parameter), gst_username (header parameter), state_cd (header parameter), ip_address (header parameter), txn (header parameter), client_id (header parameter), client_secret (header parameter). No request body payload is required for this call.

For Get User Masters (GET /all/getmasters), responses are returned in JSON format (application/json). Documented response codes in the specification include: HTTP 404 (Not Found. If requested entity is not found or if requested API is not found.), HTTP 500 (Internal server error).

This API is used to Get User Masters

Save User Masters

Get File Details

GET/all/getmasters

1const response = await fetch('https://apisandbox.whitebooks.in/all/getmasters?email=value&gstin=value', {

2 method: 'GET',

3 headers: {

4 ret_period: "value",

5 gst_username: "value",

6 state_cd: "value",

7 ip_address: "value",

8 txn: "value",

9 client_id: "value",

10 client_secret: "value"

11},

12});

14const data = await response.json();

15console.log(data);

No example available.