Skip to main content
GET
List Live Updates

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

phone_number_id
integer

Filter updates by specific phone number/location

type
enum<string>

Filter updates by type

Available options:
announcement,
wait_time,
flash_sale,
closure,
schedule_change
status
enum<string>

Filter updates by current status

Available options:
scheduled,
active,
expired,
cancelled
active_only
boolean

If true, only return currently active updates

not_expired_only
boolean

If true, include both active and scheduled updates while excluding expired ones

per_page
integer
default:20

Number of items per page for pagination

Required range: 1 <= x <= 100

Response

Paginated list of live updates

data
object[]
meta
object