celebration-entries

List celebration entries

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

Notes.

  • Only entries at locations the caller can see.
get/v1/celebration-entries

Request

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

Query parameters

limitinteger

Page size. Omit to get every row; pass it to page by cursor.

cursorstring

The nextCursor of the previous page.

count'1'

With limit: also return total, the number of matching rows.

usableAtstring

Location id: only rows usable at that location (homed there, at the workspace root, or shared to it).

Response

Success.

nextCursorstring nullable

Present when ?limit was passed. Send it back as ?cursor= for the next page; null on the last page.

totalinteger

Total matching rows, when the route computes it.

Changes

No recorded changes to this operation across all 1 revision of this API.