Get one Agent Enrollment
Check the exact one-time Agent Enrollment created for a managed customer and correlate it with the connected Agent.
GET
/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}API version: v1operationId: getPartnerAgentEnrollmentView as MarkdownWhat this endpoint does
Check the exact one-time Agent Enrollment created for a managed customer and correlate it with the connected Agent.
Authentication
Send a one-time RS256 Developer Application assertion in Authorization: Bearer <application_assertion>. This assertion is not a Public API access token.
Request
Production base URL: https://public-api.cloudprint.me/partner-api/v1/accounts/{relationshipId}/agent-enrollments/{enrollmentId}
Parameters
| Name | Location | Type | Required | Description | Constraints |
|---|---|---|---|---|---|
relationshipId | path | string (uuid) | yes | Stable UUID of the partner's relationship with the managed customer. | — |
enrollmentId | path | string (uuid) | yes | Stable UUID of the Agent Enrollment addressed by the path. | — |
X-Request-Id | header | string | no | Optional request identifier for tracing; CloudPrint returns a safe value in the response header. | maxLength: 128; example: "order-100045-attempt-1" |
Request body
This endpoint has no request body.
Example requests
cURL
bash
curl -sS \
"https://public-api.cloudprint.me/partner-api/v1/accounts/$RELATIONSHIP_ID/agent-enrollments/$ENROLLMENT_ID" \
-H "Authorization: Bearer $APPLICATION_ASSERTION"Response
HTTP status: 200 — Agent Enrollment
Response fields
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
agent_enrollment_id | string (uuid) | yes | Stable identifier of the Agent Enrollment. | — |
name | string | yes | Human-readable resource name shown to account operators. | — |
status | string | yes | Current resource or workflow state; use the endpoint-specific enum values. | enum: pending, claimed, expired, revoked |
expires_at | string (date-time) | yes | ISO 8601 timestamp recorded by CloudPrint. | — |
created_at | string (date-time) | yes | ISO 8601 timestamp recorded by CloudPrint. | — |
agent_id | string | null (uuid) | yes | Stable UUID of the connected CloudPrint agent. | — |
claimed_at | string | null (date-time) | yes | ISO 8601 timestamp recorded by CloudPrint. | — |
revoked_at | string | null (date-time) | yes | ISO 8601 timestamp recorded by CloudPrint. | — |
Example response
json
{
"agent_enrollment_id": "11111111-1111-4111-8111-111111111111",
"name": "string",
"status": "pending",
"expires_at": "2026-08-06T12:00:00Z",
"created_at": "2026-08-06T12:00:00Z",
"agent_id": "11111111-1111-4111-8111-111111111111",
"claimed_at": "2026-08-06T12:00:00Z",
"revoked_at": "2026-08-06T12:00:00Z"
}Errors
| HTTP status | Description |
|---|---|
401 | Application assertion is invalid |
403 | Developer Account production access is not active |
404 | Managed Account or Agent Enrollment was not found |
422 | Relationship ID or Agent Enrollment ID is invalid |
429 | Rate limit exceeded |
500 | Unexpected error |
Integration guidance
- Persist
agent_enrollment_idwhen creating the link and poll this exact resource; do not infer completion from another Agent already connected to the account. - Continue while the status is
pending. When it becomesclaimed, store the returnedagent_id; stop polling onexpiredorrevoked.
Related documentation
Create a managed Agent EnrollmentIssue an idempotent one-time Enrollment before or after customer onboarding.Revoke an Agent EnrollmentRevoke one unclaimed Enrollment so its secret can no longer connect an Agent.Set up an Agent for a managed accountCreate a one-time setup link and connect CloudPrint Agent to the correct customer account without a portal login.