---
title: "List celebration entries"
method: GET
path: "/v1/celebration-entries"
tags: ["celebration-entries"]
---

# List celebration entries

`GET /v1/celebration-entries`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/celebration-entries`
- Auth: HTTP bearer

Return the roster of birthdays, anniversaries, and other occasions that the Celebrations app displays.

**Notes.**
- Only entries at locations the caller can see.

## Query parameters

- `limit` integer
- `cursor` string
- `count` '1'
- `usableAt` string

## Response `200`

Success.

- object
  - `data` CelebrationEntry[], required
    - `id` string, required
    - `spaceId` string, required
    - `nodeId` string, nullable, required: Home location; null = workspace root. Follows the data source's location when not set.
    - `sourceId` string, nullable, required: The data source it came from, if any.
    - `name` string, required
    - `photoUrl` string, nullable, required
    - `occasionType` 'birthday' | 'anniversary' | 'custom', required
    - `occasionMonth` integer, nullable, required: 1–12.
    - `occasionDay` integer, nullable, required: 1–31.
    - `occasionYear` integer, nullable, required: The start year for an anniversary.
    - `department` string, nullable, required
    - `title` string, nullable, required
    - `location` string, nullable, required
    - `customMessage` string, nullable, required
    - `externalId` string, nullable, required: The id in the source system, for de-duplication.
    - `createdAt` string, required: ISO-8601 timestamp (UTC).
    - `updatedAt` string, required: ISO-8601 timestamp (UTC).
    - `deletedAt` string, nullable, required: ISO-8601 timestamp (UTC).
  - `nextCursor` string, nullable: Present when `?limit` was passed. Send it back as `?cursor=` for the next page; null on the last page.
  - `total` integer: Total matching rows, when the route computes it.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)