Skip to content
Cordboard Documentation

Get active box detail

GET
/v1/ns/{nsid}/vm/boxes/{context}/{box}
curl --request GET \
  --url https://example.com/v1/ns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/vm/boxes/example/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
nsid
required
string format: uuid

Namespace UUID

context
required
string
box
required
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
success
required
boolean
context
required
string
box
required
string
email
string
envelope_autoplay
required
boolean
unread
required
integer
read
required
integer
urgent_unread
required
integer
pin_set
required
boolean
greetings
required
Array<string>
temp_greeting_active
required
boolean
Examplegenerated
{
  "success": true,
  "context": "example",
  "box": "example",
  "email": "example",
  "envelope_autoplay": true,
  "unread": 1,
  "read": 1,
  "urgent_unread": 1,
  "pin_set": true,
  "greetings": [
    "example"
  ],
  "temp_greeting_active": true
}

default

Section titled “default”

Error response

Media typeapplication/problem+json

RFC 7807 Problem Details

object
type

Problem type slug URI

string
title
string
status
integer
detail
string
key
additional properties
any
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}