/getLimits

1 min

POST

/getLimits

-------------------- Request --------------------

  {
      "FunctionData": {
          "UserIds": [
              "1"
          ]
      },
      "Meta": {
          "AccessToken": "34090d917106c6947d1c21fad4067207e2d24c02a2299bb932f353375bfcd074",
          "Destination": "414939906fb533af444db36049486bd16a7d3d857e9e045209ffc0793db2702f0dbbefec7c8e95698014508d3cd17dd413d0c636ce77d6ff5d9f6722d6e822d38c",
          "FunctionName": "getLimits",
          "RandomData": "32d1279bd8aad78dcf1adf43ee8d4591c5bce71c885a3d2446141fc3caf7f7c4",
          "Source": "0468e5f9446d88c5991c8bc40e7707af258b2a34cba8c51850e5c04373de82df0ae1b8a3ba76e058cc943980ac2516dfd198c7ee773fe1a5dd11a8fd510b83eaf7",
          "Time": "2025-01-31 15:39:08.392456"
      }
  }

  -------------------- Response --------------------

  {
      "FunctionData": [],
      "Meta": {
          "AccessToken": "43f486920ce195d6cbd049df271cd15d8f100570ebccf5e7beb83b4e91310ea8",
          "Destination": "0468e5f9446d88c5991c8bc40e7707af258b2a34cba8c51850e5c04373de82df0ae1b8a3ba76e058cc943980ac2516dfd198c7ee773fe1a5dd11a8fd510b83eaf7",
          "Source": "414939906fb533af444db36049486bd16a7d3d857e9e045209ffc0793db2702f0dbbefec7c8e95698014508d3cd17dd413d0c636ce77d6ff5d9f6722d6e822d38c",
          "Time": "2025-01-31 15:39:08.406"
      }
  }

Retrieve the limits for the specified users. This endpoint is part of the transaction flow detailed at https://docs.gk8.io/api-v19/sending-transactions-from-the-api. See the linked article for output example.

return: JSON containing user's data limits specifications.

example: getLimits()

userIdsarray<p>List of users to check their limits (Optional, will check all users if none are specified).</p>

acceptstringGenerated from available response content types

bodyobjectData containing user IDs.

200success

curl --request POST \
     --url '/getLimits?userIds=alice%40gk8.com%2Cbob%40gk8.com' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "Meta": {
     "FunctionName": "getLimits",
     "RandomData": "288cd49d4b8bf00e7d6114b78d5668d5581d6b953fafef779133caa844cd4229",
     "Destination": "b9cb8afe52f1d52521cf2b62dfe12146156ad5328f83c62c20c7da81b263356a61340de745c858998544c041798b01c2f4fac31bebe52a19280a32cd57d6d374ea",
     "Time": "2021-02-07T18:37:46.948Z",
     "Source": "048b99461a70a49abe63fd585cb224177a22a92d2e9e4ddfbc0027887bee9d1843388f42a3eb2e740565e115ad8b7981abf59e3b03b771f4b063b53c517d7a9d99",
     "AccessToken": "51311c84d2c8fd2fafbe56ceb1fb30a99d3417abfc55769577338ab286798087"
     }
     }'