REST API Overview

The Screenzzie REST API allows you to programmatically manage your digital signage screens, playlists, media, and schedules. Perfect for integrations, automation, and custom applications.

Base URL

All API endpoints are available at:

https://www.screenzzie.com/api/v1

Authentication

The API uses Bearer token authentication with API keys. Include your API key in the Authorization header:

curl -X GET "https://www.screenzzie.com/api/v1/screens" \
  -H "Authorization: Bearer sk_live_your_api_key_here" \
  -H "Content-Type: application/json"

Getting an API Key

1. Go to Settings > API Keys in your Screenzzie dashboard
2. Click Create API Key
3. Choose a descriptive name and select permissions
4. Copy your key immediately (it's shown only once!)

API Key Scopes

When creating an API key, you can choose from three permission levels:

Rate Limits

API requests are rate-limited based on your subscription plan:

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1704067200

Response Format

All responses are returned in JSON format with a consistent structure:

Success Response

{
  "success": true,
  "data": {
    // Resource data here
  }
}

Paginated Response

{
  "success": true,
  "data": {
    "items": [...],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 100,
      "totalPages": 5,
      "hasMore": true
    }
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Name is required",
    "details": { ... }
  }
}

Error Codes

Available Endpoints

The API provides the following resources:

• Screens - Manage your digital signage screens
• Playlists - Create and manage playlists
• Media - Access and register media files
• Schedules - Schedule content (Growth plan)

Next Steps

• View the API Endpoints reference
• Create your first API Key in the dashboard