Skip to content
Voicebot

Get account

GET
/v1/internal/account/{sid}
curl --request GET \
  --url https://example.com/v1/internal/account/example

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
sid
required
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
sid
required
string
tenant_sid
required
string
name
required
string
email
required
string
external_id
required
string
country
required
string
timezone
required
string
phone
required
string
status
required
string
Allowed values: active inactive
deleted_at
required
string format: date-time
nullable
Example
{
  "status": "active"
}

404

Section titled “404”

Resource does not exist

Media typeapplication/json
object
error
required

Stable lower_snake_case usecase code (e.g. scenario_not_found)

string
code
required

Registered machine code — generic ERRxxx by status class (ERR001–ERR020 reserved); entity-prefixed codes (SCN1xx) appear only inside validation details; registry in docs/specifications/error-envelope-design.md, append-only, never renumbered

string
message
required
string
data

Structured details, present only where there is structure to carry: validation failures (topic validation, per-entity errors) and delete conflicts (topic conflict, referencing agents)

object
topic
string
errors

Validation errors keyed by entity

object
scenario
Array<object>
object
code

SCN1xx constructor validation code

string
message
string
summary
string
tree_id
string
node_id
string
output_type
string
duplicate_tree_index
string
duplicate_node_index
string
property
string
invalid_value
string
agents

Ids of the agents referencing the resource a delete was rejected for; first 20 — message carries the total count

Array<string>
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "data": {
    "topic": "example",
    "errors": {
      "scenario": [
        {
          "code": "example",
          "message": "example",
          "summary": "example",
          "tree_id": "example",
          "node_id": "example",
          "output_type": "example",
          "duplicate_tree_index": "example",
          "duplicate_node_index": "example",
          "property": "example",
          "invalid_value": "example"
        }
      ]
    },
    "agents": [
      "example"
    ]
  }
}