Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview

List overlays

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

GET/overlays
Authorization
AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired

A TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.

Responses
200

The 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> | null
updated_atstring<date-time> | null
401

Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).

errorstringrequired

Human-readable message.

codestring

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

403

The key lacks the required scope (missing_scope).

errorstringrequired

Human-readable message.

codestring

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

required_scopestring
429

Rate limit exceeded - check the RateLimit-* headers.

errorstring
Try it
Server
Authorization
Request
curl -X GET 'https://api.tippage.com/v1/overlays' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
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"
    }
  ]
}