Skip to main content
GET
https://api.zbdpay.com
/
api
/
v1
/
rewards
/
app
/
{rewardsAppId}
/
api-version-blocklist
Get Blocklist Entries
curl --request GET \
  --url https://api.zbdpay.com/api/v1/rewards/app/{rewardsAppId}/api-version-blocklist \
  --header 'Authorization: <authorization>' \
  --header 'z-client: <z-client>'
{
  "success": true,
  "message": "Success.",
  "data": [
    {
      "id": "bb6178d1-4fb5-4b35-93d6-31fe052b73dd",
      "rewardsAppId": "b28e0306-2c06-4092-8d56-a1623d6b97fb",
      "version": 1,
      "apiRoute": "/rewards/limited-achievement/reward",
      "createdAt": "2025-10-30T22:56:28.666Z"
    }
  ]
}
Retrieve all blocklist entries for your Rewards App to see which API routes are currently restricted for client-side calls.

​
Configuration

​
Header Parameters

​
z-client
string
required
Client identifier (use “developer-dashboard” )
​
Authorization
string
required
Bearer token for authenticationFormat: Bearer {JWT_TOKEN}
​
version
number
Filter by API version (optional)Example: 1
​
apiRoute
string
Filter by API route (optional)Example: /rewards/limited-achievement/reward

​
Path Parameters

​
rewardsAppId
string
required
Your Rewards App ID
{
  "success": true,
  "message": "Success.",
  "data": [
    {
      "id": "bb6178d1-4fb5-4b35-93d6-31fe052b73dd",
      "rewardsAppId": "b28e0306-2c06-4092-8d56-a1623d6b97fb",
      "version": 1,
      "apiRoute": "/rewards/limited-achievement/reward",
      "createdAt": "2025-10-30T22:56:28.666Z"
    }
  ]
}

​
Response Status Codes

CodeDescription
200Blocklist entries retrieved successfully
401Unauthorized - authentication required
403Forbidden - developer does not own this app
500Internal server error
 
{
  "success": false,
  "message": "Authentication required"
}

​
Response Fields

FieldTypeDescription
successbooleanWhether the request was successful
messagestringResponse message
dataarrayArray of blocklist entries
idstringUnique identifier for the blocklist entry
rewardsAppIdstringYour Rewards App ID
versionnumberBlocked API version
apiRoutestringBlocked API route
createdAtstringISO 8601 timestamp of when entry was created

​
Code Examples

const rewardsAppId = 'YOUR_REWARDS_APP_ID';
const jwtToken = 'YOUR_JWT_TOKEN';

async function getBlocklistEntries(rewardsAppId) {
  const response = await fetch(
    `https://api.zbdpay.com/api/v1/rewards/app/${rewardsAppId}/api-version-blocklist`,
    {
      method: 'GET',
      headers: {
        'z-client': 'developer-dashboard',
        'Authorization': `Bearer ${jwtToken}`,
        'version': '1',
        'apiRoute': '/rewards/limited-achievement/reward'
      }
    }
  );

  const data = await response.json();

  if (data.success) {
    console.log(`Found ${data.data.length} blocklist entries`);
    data.data.forEach(entry => {
      console.log(`- Route: ${entry.apiRoute}, Version: ${entry.version}`);
    });
    return data.data;
  } else {
    throw new Error(`Failed: ${data.message}`);
  }
}

// Get all entries
const entries = await getBlocklistEntries('b28e0306-2c06-4092-8d56-a1623d6b97fb');
Empty Response. If data is an empty array [], it means no blocklist entries exist and client-side reward sending is currently enabled.

​
Try It Out

Ready to view your blocklist entries? Use our API playground on the right to test with your JWT token.

​
What’s Next?

After viewing your blocklist entries: Delete Blocklist Entry. Remove a restriction to re-enable client-side rewards