# Wallboard Digital Signage API
> Enterprise digital signage CMS platform for managing devices, content, and campaigns

## Overview
Wallboard is a digital signage content management system. The API uses OAuth 2.0 authentication
and follows REST conventions. All endpoints use the `/api/` prefix.

## Machine-Readable API Documentation
All OpenAPI 3.0 specifications are available in YAML format:

- [Getting Started](https://docs.wallboard.us/openapi/getting-started.yaml): API overview, pagination, WBQL query language, field selection
- [Authentication](https://docs.wallboard.us/openapi/authentication.yaml): OAuth 2.0 authentication (3 endpoints)
- [Devices](https://docs.wallboard.us/openapi/devices.yaml): Device management, commands, configuration (95 endpoints)
- [Content](https://docs.wallboard.us/openapi/content.yaml): Content creation and management (54 endpoints)
- [Campaigns](https://docs.wallboard.us/openapi/campaigns.yaml): Campaign/channel scheduling (29 endpoints)
- [Files](https://docs.wallboard.us/openapi/files.yaml): File and media management (47 endpoints)
- [Users](https://docs.wallboard.us/openapi/users.yaml): User and team management (38 endpoints)
- [Data Sources](https://docs.wallboard.us/openapi/datasources.yaml): External data integration - Google Sheets, Excel, RSS, databases (28 endpoints)
- [Alerts](https://docs.wallboard.us/openapi/alerts.yaml): Notification rules and channels (20 endpoints)
- [Webhooks](https://docs.wallboard.us/openapi/webhooks.yaml): Webhook management for automation (18 endpoints)
- [Administration](https://docs.wallboard.us/openapi/administration.yaml): Customer, license, and admin functions (23 endpoints)
- [Statistics](https://docs.wallboard.us/openapi/statistics.yaml): Proof of play and analytics (10 endpoints)
- [Quick Filters](https://docs.wallboard.us/openapi/quick-filters.yaml): Saved search/filter management (7 endpoints)
- [Device Metrics](https://docs.wallboard.us/openapi/device-metrics.yaml): Device health and performance monitoring (2 endpoints)

## Quick Start
1. Authenticate via OAuth 2.0 to get a Bearer token
2. Include `Authorization: Bearer <token>` header in all requests
3. Use `customerId` parameter for multi-tenant operations


## API Reference (AI-Optimized Documentation)
Machine-readable API documentation optimized for AI assistants:

- [Api Conventions](https://docs.wallboard.us/api-reference/api-conventions.md): Multi-tenancy, response conventions, flat API, error handling
- [Authentication](https://docs.wallboard.us/api-reference/authentication.md): OAuth 2.0 flows (PKCE and client_secret), token handling
- [Core Concepts](https://docs.wallboard.us/api-reference/core-concepts.md): Platform overview, content types, delivery methods, scheduling
- [Examples](https://docs.wallboard.us/api-reference/examples.md): Common use-case queries, practical examples
- [Query Params](https://docs.wallboard.us/api-reference/query-params.md): Pagination, sorting, select parameter
- [Terminology](https://docs.wallboard.us/api-reference/terminology.md): UI to API term mapping, entity relationships
- [Wbql](https://docs.wallboard.us/api-reference/wbql.md): Query language syntax, operators, filtering patterns
## Human-Readable Documentation
- [Getting Started Guide](https://docs.wallboard.us/docs/api/getting-started/)
- [Full Documentation](https://docs.wallboard.us/)

## Platform Architecture Documentation
Technical documentation explaining how Wallboard works internally. Useful for AI assistants and developers building integrations.

### Content System
- [Channels](https://docs.wallboard.us/platform/content/channels.md): Channel architecture, playback logic, balancing, sub-channels
- [Content Editor](https://docs.wallboard.us/platform/content/content-editor.md): Editor components, widgets, templates
- [Scheduling](https://docs.wallboard.us/platform/content/scheduling.md): Time-based content scheduling
- [Content Actions](https://docs.wallboard.us/platform/content/content-action-system.md): Action system architecture

### Data Sources
- [Core Architecture](https://docs.wallboard.us/platform/datasources/core_datasource_architecture.md): Datasource system overview
- [External Sources](https://docs.wallboard.us/platform/datasources/external-datasource-complete.md): Google Sheets, Excel, RSS, databases
- [Data Binding](https://docs.wallboard.us/platform/datasources/data-binding.md): Binding data to content widgets
- [AI Datasources](https://docs.wallboard.us/platform/datasources/ai-datasources.md): AI-powered data sources
- [Cloud Credentials](https://docs.wallboard.us/platform/datasources/cloud_credentials_system.md): OAuth, API keys management
- [Internal Actions](https://docs.wallboard.us/platform/datasources/internal-datasource-actions.md): Internal datasource operations

### Devices
- [Device Management](https://docs.wallboard.us/platform/devices/device-management.md): Device lifecycle, registration, sync, commands

### Features
- [Notifications](https://docs.wallboard.us/platform/features/notifications.md): Alert and notification system
- [Proof of Play](https://docs.wallboard.us/platform/features/proof-of-play.md): Analytics and playback reporting
- [Quick Filters](https://docs.wallboard.us/platform/features/quick-filters.md): WBQL-based filtering system
- [Shared Folders](https://docs.wallboard.us/platform/features/shared_folders.md): Cross-team content sharing
- [User Management](https://docs.wallboard.us/platform/features/user-management.md): Users, teams, permissions

### System
- [Infrastructure](https://docs.wallboard.us/platform/system/backend-infrastructure.md): Backend architecture overview
- [Security](https://docs.wallboard.us/platform/system/security.md): Security model and practices
- [Compliance](https://docs.wallboard.us/platform/system/compliance.md): Regulatory compliance
- [General](https://docs.wallboard.us/platform/system/general.md): General system information