Skip to main content
GET /v1/instances/:instanceId Returns details for a single instance, including its current active call queue (calls in QUEUED, RINGING, or IN_PROGRESS state).

​
Request

​
Headers

HeaderValue
AuthorizationBearer <token>

​
Path parameters

ParameterTypeDescription
instanceIdstringThe instance ID (e.g., inst_abc123)

​
Response 200

FieldTypeDescription
idstringUnique instance ID
namestringInstance label
statusstringCREATED, CONFIGURED, or ACTIVE
metadataobjectInstance metadata
callQueuearrayActive calls on this instance
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp
{
  "id": "inst_abc123",
  "name": "sales-team-a",
  "status": "ACTIVE",
  "metadata": {},
  "callQueue": [
    {
      "id": "call_xyz789",
      "type": "FIXED_TTS",
      "status": "QUEUED",
      "target_phone": "+14155550123",
      "created_at": "2026-03-01T10:01:00Z"
    }
  ],
  "created_at": "2026-03-01T10:00:00Z",
  "updated_at": "2026-03-01T10:00:00Z"
}

​
Errors

CodeDescription
401Missing or invalid token
404Instance not found or does not belong to the authenticated user

​
Example

curl https://cawme.com/api/v1/instances/inst_abc123 \
  -H "Authorization: Bearer <token>"