JUjumpcloud
Agents

Retrieve an agent

Retrieves an agent in your organization.

get/api/v2/agents/{agent_id}

Request

Path parameters

agent_idstring required

Agent object ID (24-character hexadecimal string).

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Response

Agent retrieved successfully

idstring required

Agent ID (24-character hexadecimal string).

organizationIdstring required

Organization ID (24-character hexadecimal string).

namestring required

Agent name

descriptionstring

Free-text description of this agent

emailstring email required

Company email address for this agent

ownerIdstring nullable

ID of the human user who owns this agent. Required at creation; becomes null only if the owning user is later deleted.

state'active' | 'suspended' required

Lifecycle state (active or suspended).

Changes

No recorded changes to this operation across all 1 revision of this API.