screens:readScreens
Browse safe screen identity, presentation metadata, availability, and status.
Developers
Bring SignageWall into your platform
Use a secure, read-only API to understand screens and effective playback state without depending on SignageWall's internal player or CMS contracts.
Deliberate access
One API, four independent permissions
Grant each integration only the resources it needs. Permissions are immutable, so rotation and permission changes remain explicit and auditable.
playback:readPlayback
Resolve the effective, allowlisted content configuration for a known screen.
playlists:readPlaylists
Read playlist metadata and ordered content references.
media:readMedia
Read approved playback metadata and opaque public content locations.
Small, stable surface
Read the state that matters
Start with an organization-scoped credential, then request only the resource views your service needs. Every response is a Partner-owned projection designed to stay stable while SignageWall evolves behind it.
- Predictable data and pagination envelopes
- Tenant-constrained resource lookups
- Generic errors with request IDs
- Credential and organization quota metadata
Partner API v1 HTTPS
GET /api/partner/v1/screens
screens:read
GET /api/partner/v1/screens/{screenId}/configuration
playback:read
GET /api/partner/v1/playlists
playlists:read
The configuration route is independently protected by playback:read.
Designed for production
A public contract with private boundaries
The API exposes an explicit external model—not database records, arbitrary application configuration, or the internal player protocol.
Tenant isolated
Organization identity comes from the credential and is enforced in every resource query.
Default deny
New internal fields stay private until they are deliberately added to a Partner mapper.
Safe rotation
Run multiple credentials during migration, then revoke the previous credential without changing it.
Layered protection
HTTPS, Bearer-only authentication, identity quotas, no-store responses, and opaque URLs work together.
Partner API v1
Start with the quickstart
Learn authentication, choose the right scopes, and make your first request in a few minutes.