Skip to content

List changelog entries

GET
/v1/changelog/entries

Entries in reverse-chronological order, cursor-paginated (meta.next_cursor), with meta.project_plan.

Auth: a key is required. With a secret key you get every entry (filter with status). With a publishable key you get exactly what the public sees: published, audience public, not past expires_at (drafts, scheduled, signed-in and segment entries never appear). For per-person lists with reactions and unseen counts, use GET /v1/changelog/widget/entries.

CORS: Access-Control-Allow-Origin: *.

limit
integer
default: 20 >= 1 <= 100
cursor
string
status
string
Allowed values: draft published scheduled archived

Secret key only.

category
string
Allowed values: feature fix improvement security breaking
since
string format: date-time
label
string

A label slug.

q
string
<= 100 characters

Words in the title or text.

Paginated list of entries

object
data
required
Array<object>
object
id
required
string
/^ce_[0-9A-HJKMNP-TV-Z]{26}$/
project_id
required
string
/^prj_[0-9A-HJKMNP-TV-Z]{26}$/
title
required
string
>= 1 characters <= 200 characters
body_markdown
required
string
version
required
Any of:
string
category
required
string
Allowed values: feature fix improvement security breaking
status
required
string
Allowed values: draft published scheduled archived
scheduled_at
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
published_at
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
updated_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
notify_subscribers
required
boolean
notify_in_app
required
boolean
notify_chat
required
boolean
public_url
required
string format: uri
cover_image_url
required
Any of:
string
cta_label
required
Any of:
string
cta_url
required
Any of:
string
labels
required
Array<object>
object
id
required
string
slug
required
string
name
required
string
colour
required
string
Allowed values: gray red orange amber green teal blue indigo purple pink
audience
required
string
Allowed values: public signed_in segment
segment
required
Any of:
object
match
required
string
default: all
Allowed values: all any
rules
required
Array
>= 1 items <= 10 items
One of:
object
type
required
string
key
required
string
/^[a-z][a-z0-9_]{0,39}$/
op
required
string
Allowed values: eq neq in exists
value
Any of:
string
<= 200 characters
pinned
required
boolean
expires_at
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
announcement
required
Any of:
object
style
required
string
Allowed values: modal banner toast
until
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
active
required
boolean
error
required
null
meta
object
key
additional properties