List overlays

Every overlay on the account. Overlay keys are deliberately never returned. Requires overlays:manage.

GET/overlays

Authorization

AuthorizationBearer token (tp_live_...) · headerrequired

A TipPage API key, created in Dashboard → Settings → Developer.

Responses

200The account's overlays.

overlaysOverlay[]

Show properties

Array of Overlay

idstring

namestring

resolutionobject

The overlay's fixed canvas resolution in pixels.

Show properties

widthinteger

heightinteger

created_atstring<date-time>

updated_atstring<date-time>

401Missing or invalid API key (`missing_api_key` / `invalid_api_key`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

403The key lacks the required scope (`missing_scope`).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. `missing_scope`, `not_in_queue`).

required_scopestring

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X GET "https://api.tippage.com/v1/overlays" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.tippage.com/v1/overlays", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.tippage.com/v1/overlays",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "overlays": [
    {
      "id": "o_1a2b3c4d",
      "name": "Main overlay",
      "resolution": {
        "width": 1920,
        "height": 1080
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}