Workspace configuration
List workspace phone numbers
Lists the phone numbers the workspace owns, 100 at a time. Each entry shows the queue or menu the number rings, whether SautiDesk answers it and its monthly cost. To find numbers to buy, use the available list instead.
Requires: desk.read scope.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Query Parameters
limit?integer
Page size: 100 by default, and 100 at most. A larger value is treated as 100.
cursor?string
next_cursor from the previous page. Leave it out for the first page.
Response
OK
Example
{ "data": [ { "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "e164": "+254712345678", "label": "Amina Wanjiru", "status": "open", "monthly_minor": 1, "currency": "KES", "kind": "billing", "queue_id": "c70c2d37-4d65-4ba4-9843-5e8aaf2dae40", "menu_id": "af4f7978-1d4f-478d-9661-0c5affcaa9e2", "desk": false, "needs_attention": false, "sms": false } ], "next_cursor": "eyJvIjoyNX0", "has_more": false}FieldTypeDescription
datarequiredobject[]idrequiredstring (uuid)e164requiredstringlabelrequiredstringA short name to recognise it by.statusrequiredstringThe status to set.monthly_minorrequiredintegercurrencyrequiredstringThe currency code of the money in this report, for example KES. Write money figures with it. Left out when the report has no money.kindstringWhat kind it is.queue_idstring (uuid) | nullThe id of the queue that receives what arrives here.menu_idstring (uuid) | nullThe id of the phone menu to answer with.deskrequiredbooleanneeds_attentionbooleansmsrequiredbooleannext_cursorrequiredstring | nullhas_morerequiredbooleancurl -X GET "https://api.sautidesk.com/v1/desk/numbers"