+91 9211682404 Delhi NCR hello@pulse360communications.com

API

List screens, pull proof, and read menus

Growth and Enterprise. The token is shown once. These examples use YOUR_TOKEN as a placeholder.

Start a 30-day trial Sign in

A television on a wooden shelf, with a plant beside it
Contents

Start

Create a token What version 1 includes

Read

List screens Proof of play Read menus

Change

Update a price

Limits

Calls a minute Errors

How to create a token

Sign in if you already have an account, or sign up to start a 30-day trial.

  1. Open Account on a Growth or Enterprise plan.
  2. Name the token. Optionally set an expiry date and one location.
  3. Press Create token and copy the value. It is not shown again.
  4. Send it as Authorization: Bearer. Revoke removes it. The next call fails immediately, and always within a minute.

A location limits GET /api/v1/screens and GET /api/v1/proof to that branch. Menus stay account-wide. Creating, revoking, and using a token is written to the activity log. Use is recorded at most once a minute.

What version 1 includes

Version 1 is frozen. A response may gain fields. A field in these examples keeps its name and meaning. Playlist assignment, library upload, outbound webhooks, GraphQL, Zapier, and a player SDK are not part of this contract. The machine-readable spec is openapi.yaml.

How to list screens

GET https://signage.pulse360communications.com/api/v1/screens. Each screen has id, name, tag, playlist, online, and last_seen_at.

curl -s -H "Authorization: Bearer YOUR_TOKEN" "https://signage.pulse360communications.com/api/v1/screens"
const response = await fetch("https://signage.pulse360communications.com/api/v1/screens", {
  headers: { Authorization: "Bearer YOUR_TOKEN", Accept: "application/json" },
});
const body = await response.json();
import json
from urllib.request import Request, urlopen

request = Request("https://signage.pulse360communications.com/api/v1/screens", headers={"Authorization": "Bearer YOUR_TOKEN", "Accept": "application/json"})
body = json.load(urlopen(request))

How to pull proof of play

GET https://signage.pulse360communications.com/api/v1/proof?days=30 returns totals grouped by item for 30 days. Omit days for the default of 14. The largest value is 30. Add detail=1 to page the raw rows. per_page is at most 500. Each page includes total, page, per_page, and days.

curl -s -H "Authorization: Bearer YOUR_TOKEN" "https://signage.pulse360communications.com/api/v1/proof?days=30"
const proof = await fetch("https://signage.pulse360communications.com/api/v1/proof?days=30", {
  headers: { Authorization: "Bearer YOUR_TOKEN", Accept: "application/json" },
});
const report = await proof.json();
proof = Request("https://signage.pulse360communications.com/api/v1/proof?days=30", headers={"Authorization": "Bearer YOUR_TOKEN", "Accept": "application/json"})
report = json.load(urlopen(proof))

A grouped row has media_name, plays, and seconds. A detail row has media_name, seconds, played_at, and screen_id.

GET https://signage.pulse360communications.com/api/v1/menus lists each menu and its item name, price, and sold-out flag.

curl -s -H "Authorization: Bearer YOUR_TOKEN" "https://signage.pulse360communications.com/api/v1/menus"

How to update a price

POST https://signage.pulse360communications.com/api/v1/menus/{id} updates prices by item name. The sample below uses MENU_ID for that number.

curl -s -H "Authorization: Bearer YOUR_TOKEN" -H "Content-Type: application/json" \
  -d "{\"items\":[{\"name\":\"Filter coffee\",\"price\":\"150\"}]}" \
  "https://signage.pulse360communications.com/api/v1/menus/MENU_ID"
await fetch("https://signage.pulse360communications.com/api/v1/menus/MENU_ID", {
  method: "POST",
  headers: {
    Authorization: "Bearer YOUR_TOKEN",
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ items: [{ name: "Filter coffee", price: "150" }] }),
});
menu = Request(
    "https://signage.pulse360communications.com/api/v1/menus/MENU_ID",
    data=json.dumps({"items": [{"name": "Filter coffee", "price": "150"}]}).encode(),
    headers={"Authorization": "Bearer YOUR_TOKEN", "Accept": "application/json", "Content-Type": "application/json"},
    method="POST",
)
updated = json.load(urlopen(menu))

How many calls a token can make

Each token may make 120 calls a minute. The next call returns 429 with error set to rate_limited, retry_after in seconds, and a Retry-After header. Wait that long, then send the same request again.

What an error means

  • 401 token_missing — no Authorization header.
  • 401 token_invalid — the token was revoked, never existed, or its location was removed.
  • 401 token_expired — the expiry date has passed.
  • 401 plan_required — the account is not Growth or Enterprise.
  • 403 forbidden — the token cannot change that menu.
  • 404 not_found — that menu is not on this account.
  • 422 — a field is missing or too long. The field names are under errors.

The same steps, without the request samples, are on Help.