import requests
url = "https://api.example.com/api/v1/principals/{agent_id}/status"
response = requests.get(url)
print(response.text)curl --request GET \
--url https://api.example.com/api/v1/principals/{agent_id}/status{
"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>"
}
}{
"success": false,
"error": {
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}
}Get agent status
This operation retrieves the provisioning and activation status of a specific agent. The agent ID is returned as agent_id in the Provision agent response. Accepts either the internal UUID or the external ID. Requires authentication with the agent’s own API key.
import requests
url = "https://api.example.com/api/v1/principals/{agent_id}/status"
response = requests.get(url)
print(response.text)curl --request GET \
--url https://api.example.com/api/v1/principals/{agent_id}/status{
"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>"
}
}{
"success": false,
"error": {
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}
}Headers
Path Parameters
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
Agent status payload used by /principals/{id}/status.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes