Get started
Make your first request
Create a credential, verify the organization, then read the resources your integration needs.
Before you begin
You need organization-admin access to SignageWall and a server environment that can keep credentials private. Production traffic must use HTTPS.
1 Create a credential
Open Developers in the SignageWall CMS. Choose a descriptive name and only the permissions the integration requires. The complete credential appears once.
| Permission | Allows |
|---|---|
screens:read | Browse and inspect screens |
playback:read | Resolve effective screen playback |
playlists:read | Read playlists and ordered items |
media:read | Read approved media metadata |
2 Verify access
The organization endpoint accepts any valid Partner credential and is a useful first connectivity check.
GET
/api/partner/v1/organization
Any credential
curl --request GET \
--url "https://api.signagewall.com/api/partner/v1/organization" \
--header "Authorization: Bearer $SIGNAGEWALL_PARTNER_API_KEY"{
"data": {
"id": "organization_id",
"name": "Example organization",
"slug": "example-organization"
}
}3 Read resources
Collection responses use predictable pagination. This request needs screens:read.
curl --request GET \
--url "https://api.signagewall.com/api/partner/v1/screens?page=1&limit=20" \
--header "Authorization: Bearer $SIGNAGEWALL_PARTNER_API_KEY"