Fetch All Businesses

get
Fetch Businesses
https://api.quicko.com/gst/businesses?gstin={{gstin}}&count={{count}}&skip={{skip}}
 Retrieve all businesses. Provide count and skip for pagination
Request
Response
Request
Headers
Authorization
required
string
JWT Authorization token
x-api-key
required
string
Public key required to authorize API access.
x-api-version
optional
string
​
Query Parameters
gstin
optional
string
Filter business by GSTIN
count
optional
string
Number of entities to fetch. Defaults to 10
skip
optional
string
Number of entities to be skipped. Defaults to 0
Response
200: OK
[
  {
    "supporting_documents": [
      {
        "signed_url": "...",
        "document_name": "logo.jpg",
        "id": "C21D133066DC3B482486EEC4BB85411A",
        "type": "Logo",
        "url": "[email protected]/JaneDoe/logo.jpg",
        "@entity": "document"
      }
    ],
    "contact": {
      "mobile": "1234567890",
      "id": "8B0724EDAE2543A8E0530100007FF230",
      "email": "[email protected]",
      "@entity": "contact"
    },
    "name": "Jane Doe",
    "registered": false,
    "billing_address": {
      "country": "India",
      "id": "8B0724EDAE2343A8E0530100007FF230",
      "full_address": "1, ABC Lakeview Tower, Ahmedabad, India",
      "type": "Billing",
      "@entity": "address"
    },
    "id": "A193D94971D2B397B84288E5414D28E2",
    "bank_accounts": [
      {
        "account_number": "1234567890123",
        "bank_name": "Children Bank",
        "id": "8B0724EDAE2743A8E0530100007FF230",
        "type": "Current",
        "ifsc": "CKBI0000172",
        "@entity": "bank_account"
      }
    ],
    "display_name": "Jane Doe",
    "@entity": "business"
  },
  {
    "supporting_documents": [],
    "scheme": "Regular",
    "contact": {
      "mobile": "9999999999",
      "id": "91DFA2BA5686463EE0530100007FB90E",
      "email": "[email protected]",
      "@entity": "contact"
    },
    "name": "JOHN DOE PRIVATE LIMITED",
    "registered": true,
    "billing_address": {
      "country": "India",
      "id": "91DFA2BA5684463EE0530100007FB90E",
      "full_address": "1, ABC Lakeview Tower, Ahmedabad, Gujarat - 380015",
      "type": "Billing",
      "@entity": "address"
    },
    "id": "B25D0CBD14216AA9DA699A6B6281BD89",
    "bank_accounts": [],
    "display_name": "John Doe Private Limited",
    "gstin": "24AAACQ3770E2ZZ",
    "@entity": "business",
    "filing_frequency": "Quarterly"
  }
]
​
401: Unauthorized
{
  "code": 401,
  "message": "Unauthorized"
}
403: Forbidden
Access denied
Not a valid token
Access denied
{
  "code": 403,
  "message": "Access denied"
}
Not a valid token
{
  "code": 403,
  "message": "Not a valid token"
}
500: Internal Server Error
{
  "code": 500,
  "message": "Failed to fetch businesses"
}
Example Request
cURL
Java
Node.js
Python
cURL
curl --location --request GET 'https://api.quicko.com/gst/businesses' \
--header 'Authorization: eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw' \
--header 'x-api-key: key_live_Ade**************************Uxs' \
--header 'x-api-version: 3.3'
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://api.quicko.com/gst/businesses")
  .header("Authorization", "eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw")
  .header("x-api-key", "key_live_Ade**************************Uxs")
  .header("x-api-version", "3.3")
  .asString();
Node.js
var https = require('follow-redirects').https;
var fs = require('fs');
​
var options = {
  'method': 'GET',
  'hostname': 'https://api.quicko.com',
  'path': '/gst/businesses?',
  'headers': {
    'Authorization': 'eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw',
    'x-api-key': 'key_live_Ade**************************Uxs',
    'x-api-version': '3.3'
  },
  'maxRedirects': 20
};
​
var req = https.request(options, function (res) {
  var chunks = [];
​
  res.on("data", function (chunk) {
    chunks.push(chunk);
  });
​
  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
​
  res.on("error", function (error) {
    console.error(error);
  });
});
​
req.end();
Python
import requests
​
url = "https://api.quicko.com/gst/businesses"
​
payload = {}
headers = {
  'Authorization': 'eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJBUEkiLCJyZWZyZXNoX3Rva2VuIjoiZXlKaGJHY2lPaUpJVXpVeE1pSjkuZXlKaGRXUWlPaUpCVUVraUxDSnpkV0lpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1Gd2FWOXJaWGtpT2lKclpYbGZiR2wyWlY5QlpHVXFLaW9xS2lvcUtpb3FLaW9xS2lvcUtpb3FLaW9xS2lvcUtsVjRjeUlzSW1semN5STZJbUZ3YVM1eGRXbGphMjh1WTI5dElpd2laWGh3SWpveE5Ua3dPVFk1TmpBd0xDSnBiblJsYm5RaU9pSlNSVVpTUlZOSVgxUlBTMFZPSWl3aWFXRjBJam94TlRVNU16UTNNakF3ZlEueHNmYkhQTERFRlRvTy1OUWdaUUpLM25OUjFxdlhvWmhaOHRqS3gzSExydjZiVkJaMHpJZEZ5ai1MUTg1YnJZS0xXQnFnZHlzZ1NDSXlDUXNtV2VOYkEiLCJzdWIiOiJqb2huQGRvZS5jb20iLCJhcGlfa2V5Ijoia2V5X2xpdmVfQWRlKioqKioqKioqKioqKioqKioqKioqKioqKipVeHMiLCJpc3MiOiJhcGkucXVpY2tvLmNvbSIsImV4cCI6MTU5MTA1NjAwMCwiaW50ZW50IjoiQUNDRVNTX1RPS0VOIiwiaWF0IjoxNTkwOTY5NjAwfQ.nH23CR5RHGQ0U19I_vq3vyJ_85A1a2iEMQij5QHgJQdDuS9x7FmTidsr1CQabSFF5ujE40SFxHv1gJM20TauUw',
  'x-api-key': 'key_live_Ade**************************Uxs',
  'x-api-version': '3.3'
}
​
response = requests.request("GET", url, headers=headers, data = payload)
​
print(response.text.encode('utf8'))
Fetch Business Details
Step 2 - Items
Last updated 2 months ago
Fetch All Businesses

getFetch Businesses

Example Request

get
Fetch Businesses
