List numbers

GET /v1/numbers

Returns your workspace’s WhatsApp numbers. The default number comes first.

Needs numbers:read.

Request

curl https://app.soosh.io/v1/numbers \
  -H "Authorization: Bearer $SOOSH_API_KEY"

const res = await fetch('https://app.soosh.io/v1/numbers', {
  headers: {
    Authorization: `Bearer ${process.env.SOOSH_API_KEY}`,
  },
});
console.log(await res.json());

import os
import requests

res = requests.get(
    "https://app.soosh.io/v1/numbers",
    headers={"Authorization": f"Bearer {os.environ['SOOSH_API_KEY']}"},
)
print(res.json())

Response200

{
  "data": [
    {
      "id": "0f6d3c1e-5b7a-4c52-9a55-3f6a2d5c8b10",
      "name": "Sales",
      "phone": "+912212345678",
      "display_name": "Blue Lotus Fashion",
      "verified_name": "Blue Lotus Fashion Pvt Ltd",
      "status": "active",
      "is_default": true
    }
  ],
  "next_cursor": null
}

Every field of the number object

No paging

The list isn’t paged, so next_cursor is always null. Tokens and other credentials are never included.

Returns

200 A page of number objects. Your workspace’s numbers.

Errors

Only the ones every request can get.