Get a single changelog entry

GET

/v1/changelog/entries/{entry_id}

Returns one entry by id. A secret key reads any entry; a publishable key only one the public may see (published, public, not expired), else NOT_FOUND.

Authorizations

• PublishableApiKey
• SecretApiKey

Parameters

Path Parameters

entry_id

required

string

Entry ID (ce_…)

Responses

200

Entry

object

data

required

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

string

null

null

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

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)))$/

null

null

published_at

required

Any of:

string

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)))$/

null

null

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

string

null

null

cta_label

required

Any of:

string

string

null

null

cta_url

required

Any of:

string

string

null

null

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

object

match

required

string

default: all

Allowed values: all any

rules

required

Array

>= 1 items <= 10 items

One of:

object

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

string

<= 200 characters

Array<string>

Array<string>

>= 1 items <= 20 items

object

object

type

required

string

purpose

required

string

/^[a-z][a-z0-9_]{0,39}$/

status

required

string

default: granted

Allowed values: granted withdrawn

null

null

pinned

required

boolean

expires_at

required

Any of:

string

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)))$/

null

null

announcement

required

Any of:

object

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

null

null

error

required

null

meta

object

key

additional properties

404

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties