Skip to content
vocapable.Docs

Your lines' purchases, port-ins, caller IDs, attestation and health

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceNumbersOverview

What the app shows on Business phone → Numbers: read-only status, no prices.

object
purchases
required
Purchases
Array<object>
WorkspaceNumberPurchase
object
id
required
Id
string
phone_e164
required
Phone E164
string
number_type
required
Number Type
string
Allowed values: local toll_free
line_name
required
Any of:
string
state
required
State
string
Allowed values: started unresolved acquired refused
line_id
required
Any of:
string
messaging_enrollment
required
Messaging Enrollment
string
Allowed values: pending not_applicable enrolled failed
failure_reason
required
Any of:
string
emergency_address_required
required
Emergency Address Required
boolean
requested_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
created_at
required
Created At
string format: date-time
acquired_at
required
Any of:
string format: date-time
port_ins
required
Port Ins
Array<object>
WorkspacePortIn
object
id
required
Id
string
stage
required
Stage
string
Allowed values: draft submitting waiting_for_signature submitted in_progress action_required canceling completed canceled failed
numbers
required
Numbers
Array<object>
WorkspacePortInNumber
object
phone_e164
required
Phone E164
string
status
required
Status
string
rejection_reason
required
Any of:
string
pin_on_file
required
Pin On File
boolean
business_name
required
Business Name
string
authorized_representative
required
Authorized Representative
string
authorized_representative_email
required
Authorized Representative Email
string
service_address_summary
required
Service Address Summary
string
account_number_hint
required
Any of:
string
bill_uploaded
required
Bill Uploaded
boolean
target_port_in_date
required
Any of:
string format: date
twilio_status
required
Any of:
string
signature_request_url
required
Any of:
string
last_error
required
Any of:
string
forwarding_guidance
required
Forwarding Guidance
string
can_submit
required
Can Submit
boolean
can_cancel
required
Can Cancel
boolean
revision
required
Revision
integer
submitted_at
required
Any of:
string format: date-time
last_checked_at
required
Any of:
string format: date-time
completed_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
caller_ids
required
Caller Ids
Array<object>
WorkspaceCallerId
object
id
required
Id
string
phone_e164
required
Phone E164
string
label
required
Label
string
state
required
State
string
Allowed values: pending verified failed removed
caller_id_access
required
Caller Id Access
string
Allowed values: everyone managers
validation_code
required
Any of:
string
validation_expires_at
required
Any of:
string format: date-time
failure_reason
required
Any of:
string
outbound_only
required
Outbound Only
boolean
revision
required
Revision
integer
verified_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
trust
required
WorkspaceVoiceTrust
object
business_profile
required
Business Profile
string
Allowed values: approved missing unknown
business_profile_guidance
required
Any of:
string
registrations
required
Registrations
Array<object>
WorkspaceTrustRegistration
object
kind
required
Kind
string
Allowed values: shaken_stir cnam branded_calling voice_integrity
stage
required
Stage
string
Allowed values: draft submitting in_review approved rejected
display_name
required
Any of:
string
line_ids
required
Line Ids
Array<string>
failure_reasons
required
Failure Reasons
Array<string>
twilio_status
required
Any of:
string
submitted_at
required
Any of:
string format: date-time
last_checked_at
required
Any of:
string format: date-time
lines
required
Lines
Array<object>
WorkspaceLineAttestation
object
line_id
required
Line Id
string
phone_e164
required
Phone E164
string
name
required
Name
string
kind
required
Kind
string
Allowed values: number verified_caller_id
expected
required
Expected
string
Allowed values: A B C
best_possible
required
Best Possible
string
Allowed values: A B C
reason
required
Reason
string
next_step
required
Any of:
string
cnam
required
Any of:
string
Allowed values: draft submitting in_review approved rejected
branded_calling
required
Any of:
string
Allowed values: draft submitting in_review approved rejected
can_manage
required
Can Manage
boolean
lock_notice
Lock Notice
string
""
health
required
Health
Array<object>
WorkspaceLineHealth
object
line_id
required
Line Id
string
phone_e164
required
Phone E164
string
name
required
Name
string
level
required
Level
string
Allowed values: ok watch at_risk insufficient_data
attempts_7d
required
Attempts 7D
integer
answered_7d
required
Answered 7D
integer
short_calls_7d
required
Short Calls 7D
integer
answer_rate_7d
required
Any of:
number
answer_rate_baseline
required
Any of:
number
reasons
required
Reasons
Array<string>
guidance
required
Guidance
Array<string>
web_paths
required
Web Paths
object
key
additional properties
string
Example
{
  "purchases": [
    {
      "number_type": "local",
      "state": "started",
      "messaging_enrollment": "pending"
    }
  ],
  "port_ins": [
    {
      "stage": "draft"
    }
  ],
  "caller_ids": [
    {
      "state": "pending",
      "caller_id_access": "everyone"
    }
  ],
  "trust": {
    "business_profile": "approved",
    "registrations": [
      {
        "kind": "shaken_stir",
        "stage": "draft"
      }
    ],
    "lines": [
      {
        "kind": "number",
        "expected": "A",
        "best_possible": "A",
        "cnam": "draft",
        "branded_calling": "draft"
      }
    ],
    "lock_notice": ""
  },
  "health": [
    {
      "level": "ok"
    }
  ]
}