Skip to main content
GET
/
live-updates
List Live Updates
curl --request GET \
  --url https://playground.answeringagent.com/api/v1/live-updates \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "title": "Temporary System Maintenance",
      "message": "We are currently performing system maintenance. Expected completion time is 2 PM.",
      "type": "announcement",
      "starts_at": "2025-07-25T14:00:00Z",
      "expires_at": "2025-07-25T16:00:00Z",
      "is_cancelled": false,
      "created_at": "2025-07-25T10:30:00Z",
      "updated_at": "2025-07-25T11:45:00Z",
      "phone_numbers": [
        {
          "id": 1,
          "name": "Main Office",
          "phone_number": "+1234567890"
        }
      ],
      "created_by": {
        "id": 1,
        "name": "John Doe",
        "email": "[email protected]"
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "per_page": 20,
    "to": 20,
    "total": 97
  }
}

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[]
​
links
object
​
meta
object