---
title: "List WhatsApp number events"
method: GET
path: "/v1/whatsapp/numbers/{number_id}/events"
tags: ["whatsapp-numbers"]
---

# List WhatsApp number events

`GET /v1/whatsapp/numbers/{number_id}/events`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/whatsapp/numbers/{number_id}/events`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns the number's activity history, newest first by default:

- The number being added, and every change of its status.
- A messaging-limit change reported by WhatsApp.
- A display-name review decision.
- A quality-rating change, observed when Bird next reads the number.

Use it to see when and why a number's status, limit, name, or quality changed,
rather than polling [Get a WhatsApp number](/docs/api/reference/get-whatsapp-number).
A number ID that does not belong to the workspace, or no longer exists,
returns `404`.

## Path parameters

- `number_id` string, required

## Query parameters

- `sort` 'created_at': Sortable fields for a WhatsApp number's event list.
- `order` 'asc' | 'desc': Sort direction, ascending or descending.
- `limit` integer
- `starting_after` string
- `ending_before` string

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

A page of number events.

- WhatsAppNumberEventList
  - `data` WhatsAppNumberEvent[], required: Page of number events, newest first by default.
    - `id` string, required
    - `type` string, required: Type of number event. `whatsapp_number.messaging_limit_updated` and `whatsapp_number.profile_name_update` are reported by WhatsApp as they happen; `whatsapp_number.quality_rating_updated` is observed when Bird next reads the number, so it can lag the change by up to an hour. `whatsapp_number.status_changed` records every move of the `status` field on the number itself, whichever side caused it. Open enum: new event types may be added over time, so treat any unrecognized value as a future event rather than an error. The values below are the types known at this version.
    - `summary` string, required: Human-readable summary of what changed.
    - `metadata` object, required: Structured details for the event. `from` and `to` carry the values that changed, and `from` is absent when the number had no prior value to report. A status change into `failed` also carries the `reason`; a display-name decision carries `new_display_name`, `decision`, and, when WhatsApp named one for a rejection, `rejection_reason`. A messaging-limit change also carries the `trigger` WhatsApp named for it, such as `onboarding` or `throughput_upgrade`, when it named one. A `whatsapp_number.created` event carries the `source` the number came from, and its `phone_number` once one is known.
    - `created_at` string, date-time, required: When the event was recorded.
  - `next_cursor` string, nullable, required: Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
  - `prev_cursor` string, nullable, required: Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
  - `refresh_cursor` string, nullable, required: Refresh anchor, the first row of this response. Pass back as `ending_before` to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-`null` whenever `data` is non-empty; `null` only on an empty page. Distinct from `prev_cursor`.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/3e2a50466454?raw)