Skip to content
vocapable.Docs

The company's business lines you can see

GET
/v1/workspace/phone-lines
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/phone-lines \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspacePhoneLines
object
data
required
Data
Array<object>
WorkspacePhoneLine
object
id
required
Id
string
name
required
Name
string
phone_e164
required
Phone E164
string
is_company_default
required
Is Company Default
boolean
caller_id_access
required
Caller Id Access
string
Allowed values: everyone members
members
required
Members
Array<object>
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
usable_by_you
required
Usable By You
boolean
sms_capable
required
Sms Capable
boolean
revision
required
Revision
integer
kind
required
Kind
string
Allowed values: number verified_caller_id
outbound_only
required
Outbound Only
boolean
settings
required
WorkspaceCallingSettings

The owner’s calling choices for the whole company. Every one defaults to off.

object
allow_personal_phone
required
Allow Personal Phone
boolean
allow_dial_pad
required
Allow Dial Pad
boolean
show_customer_numbers
required
Show Customer Numbers
boolean
revision
required
Revision
integer
updated_by
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
updated_at
required
Any of:
string format: date-time
allow_supervision
Allow Supervision
boolean
summary_language
Summary Language
string
default: spoken
Allowed values: spoken en es
allow_offline_text_queue
Allow Offline Text Queue
boolean
can_manage
required
Can Manage
boolean
can_change_settings
required
Can Change Settings
boolean
Example
{
  "data": [
    {
      "caller_id_access": "everyone",
      "kind": "number"
    }
  ],
  "settings": {
    "allow_supervision": false,
    "summary_language": "spoken",
    "allow_offline_text_queue": false
  }
}