Retrieve all blocklist entries for your Rewards App to see which API routes are currently restricted for client-side calls.
Configuration
Client identifier (use “developer-dashboard” )
Bearer token for authenticationFormat: Bearer {JWT_TOKEN}
Filter by API version (optional)Example: 1
Filter by API route (optional)Example: /rewards/limited-achievement/reward
Path Parameters
{
"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
| Code | Description |
200 | Blocklist entries retrieved successfully |
401 | Unauthorized - authentication required |
403 | Forbidden - developer does not own this app |
500 | Internal server error |
{
"success": false,
"message": "Authentication required"
}
Response Fields
| Field | Type | Description |
success | boolean | Whether the request was successful |
message | string | Response message |
data | array | Array of blocklist entries |
id | string | Unique identifier for the blocklist entry |
rewardsAppId | string | Your Rewards App ID |
version | number | Blocked API version |
apiRoute | string | Blocked API route |
createdAt | string | ISO 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.zebedee.io/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