List managed Agent Enrollments
List pending, claimed, expired and revoked Agent Enrollments without exposing their secret codes.
GET
/partner-api/v1/accounts/{relationshipId}/agent-enrollmentsAPI version: v1operationId: listPartnerAgentEnrollmentsView as MarkdownWhat this endpoint does
List pending, claimed, expired and revoked Agent Enrollments without exposing their secret codes.
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
Parameters
| Name | Location | Type | Required | Description | Constraints |
|---|---|---|---|---|---|
relationshipId | path | string (uuid) | yes | Stable UUID of the partner's relationship with the managed customer. | — |
limit | query | integer | no | Maximum number of resources to return on one page. | min: 1; max: 100; default: 50 |
cursor | query | string | no | Opaque cursor for the requested result page; reuse it unchanged. | — |
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" \
-H "Authorization: Bearer $APPLICATION_ASSERTION"Response
HTTP status: 200 — Agent Enrollments page
Response fields
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
data | array | yes | Resources returned on the current result page. | — |
next_cursor | string | null | yes | Opaque cursor for the next result page; send it back unchanged. | — |
Example response
json
{
"data": [
{
"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"
}
],
"next_cursor": "string"
}Errors
| HTTP status | Description |
|---|---|
401 | Application assertion is invalid |
403 | Developer Account production access is not active |
404 | Managed Account was not found |
422 | Pagination parameters are invalid |
429 | Rate limit exceeded |
500 | Unexpected error |
Related documentation
Create a managed Agent EnrollmentIssue an idempotent one-time Enrollment before or after customer onboarding.Get one Agent EnrollmentCheck the exact one-time Agent Enrollment created for a managed customer and correlate it with the connected 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.