Skip to main content
GET
/
api
/
v1
/
principals
/
{agent_id}
/
status
Get agent status
import requests

url = "https://api.example.com/api/v1/principals/{agent_id}/status"

response = requests.get(url)

print(response.text)
{
  "result": {
    "agent_id": "<string>",
    "status": "active",
    "owner_linked": true,
    "onboarding_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "success": true,
  "suggestion": "",
  "message": "",
  "meta": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "has_more": true,
    "after": "<string>",
    "before": "<string>"
  }
}

Headers

X-API-Key
string | null

Path Parameters

agent_id
string
required

The agent's unique identifier. Accepts either the internal UUID (returned as id by the Provision agent operation) or the external ID (external_id).

Response

Successful Response

result
AgentStatusResponse · object
required

Agent status payload used by /principals/{id}/status.

success
boolean
default:true
suggestion
string
default:""
message
string
default:""
meta
PaginationMeta · object

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.