---
search:
  tags:
    - Overlays
    - GET
seo:
  description: >-
    One overlay, plus the widget types currently on its layout. Requires…
    Reference for the GET /overlays/{overlayId} endpoint in the TipPage
    Developer API.
sidebar:
  label: Get one overlay
  badge: GET
title: Get one overlay
type: openapi-operation
---
One overlay, plus the widget types currently on its layout. Requires `overlays:manage`.

`GET /overlays/{overlayId}`

**Responses**

- `200` — The overlay.
- `401` — Missing or invalid credential (\`missing\_api\_key\` / \`invalid\_api\_key\`, or \`invalid\_token\` for an expired/revoked OAuth access token).
- `403` — The key lacks the required scope (\`missing\_scope\`).
- `404` — No such resource.
- `429` — Rate limit exceeded - check the \`RateLimit-\*\` headers.

Response example, 200:

```json
{
  "overlay": {
    "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",
    "widgets": [
      "alert",
      "chat",
      "celebration"
    ],
    "celebrations": [
      {
        "id": "celebration-mt9x2ab",
        "name": "Goal zone"
      }
    ]
  }
}
```
