Recent number purchases

GET

/v1/workspace/numbers/purchases

const url = 'https://api.vocapable.com/v1/workspace/numbers/purchases';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

WorkspaceNumberPurchases

object

data

required

Data

Array<object>

WorkspaceNumberPurchase

object

required

string

phone_e164

required

Phone E164

string

number_type

required

Number Type

string

Allowed values: local toll_free

line_name

required

Any of:

string
null

string

state

required

State

string

Allowed values: started unresolved acquired refused

line_id

required

Any of:

string
null

string

messaging_enrollment

required

Messaging Enrollment

string

Allowed values: pending not_applicable enrolled failed

failure_reason

required

Any of:

string
null

string

emergency_address_required

required

Emergency Address Required

boolean

requested_by

required

Any of:

WorkspacePersonRef
null

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
null

string format: date-time

Example

{
  "data": [
    {
      "number_type": "local",
      "state": "started",
      "messaging_enrollment": "pending"
    }
  ]
}