NetBird

whatsapp_numbers_list

List the WhatsApp numbers the workspace can send from as a cursor page, with each number's WhatsApp state, quality rating, messaging limit and throughput.

Remote bird/mcp

Remote (network-hosted)

Other tools also called whatsapp_numbers_list? See providers with this name

Input Schema


            {
  "type": "object",
  "properties": {
    "sort": {
      "type": "string",
      "examples": [
        "created_at"
      ],
      "description": "Field to sort by."
    },
    "waba": {
      "type": "string",
      "description": "Filter to a single WhatsApp Business Account by its Meta-assigned ID. Use the waba of a connected WhatsApp Business Account, or the waba on a number this list returns. A platform-managed number belongs to no WhatsApp Business Account and is never returned when this is set, so pairing it with scope=system always returns an empty page. An account this workspace does not hold returns an empty page."
    },
    "limit": {
      "type": "integer",
      "description": "Maximum number of items to return per page."
    },
    "order": {
      "type": "string",
      "examples": [
        "asc",
        "desc"
      ],
      "description": "Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field."
    },
    "scope": {
      "type": "string",
      "examples": [
        "system",
        "workspace"
      ],
      "description": "Filter by ownership tier: system for platform-managed numbers and workspace for numbers your workspace connected. Omit to return both. A system number belongs to no WhatsApp Business Account, so pairing this with waba always returns an empty page."
    },
    "status": {
      "type": [
        "null",
        "array"
      ],
      "items": {
        "type": "string"
      },
      "description": "Filter by the number's WhatsApp state: the status a number in this list carries. Repeat the parameter to match any of several. A number WhatsApp has reported no state for carries pending, so pending also matches every number whose connection has not finished. failed matches every number whose connection was refused permanently. A value this vocabulary does not recognize matches nothing, rather than being rejected. Omit to return numbers in every state."
    },
    "phone_number": {
      "type": "string",
      "description": "Filter to a single number, given in E.164 format. The value is normalized before matching, so +31612340001 and +31 6 1234 0001 are the same filter. A value that cannot be normalized is matched exactly as given. A number this workspace cannot send from returns an empty page, rather than being rejected."
    },
    "ending_before": {
      "type": "string",
      "description": "Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since."
    },
    "starting_after": {
      "type": "string",
      "description": "Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order."
    }
  }
}
          

Provider

NetBird →