---
title: "List WhatsApp services."
method: GET
path: "/whatsapp"
tags: ["WhatsApp"]
---

# List WhatsApp services.

`GET /whatsapp`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/whatsapp`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/whatsapp/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a collection of WhatsApp services.

## Query parameters

- `filter` string
- `search` string
- `orderby` string
- `skip` integer
- `top` integer

## Response `200`

OK

- object
  - `count` integer: Total number of resource.
  - `items` object[]
    - `id` string: The unique ID of the resource.
    - `name` string: The name of WhatsApp service.
    - `enabled` boolean: The flag for whether the WhatsApp service is enabled.
    - `phone_number` string: The phone number of WhatsApp service.
    - `phone_number_id` string: The phone number id of WhatsApp service.
    - `provider_id` string: The unique ID of the resource.
    - `provider_name` string: The name of the trunk.
    - `provider_brand` string: The brand of trunk.
    - `provider_hostname` string: Server hostname or IP address
    - `webhook` string: The `Universal Resource Locator` of some resource.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)