Operations
The operation object
Attributes
idstring (uuid)requiredIdentifier for this resource.
teamIdstring (uuid)requiredIdentifier for the team.
projectIdstring (uuid)requirednullableOwning project.
nullfor a team-owned operation.kindstringrequiredKind discriminator for this object.
Allowed valuesauth_projection_repairsession_lifecycleauth_session_purgelabel_projection_purgebilling_reconciliationauto_top_upcampaignproduction_enrollmentretention_sweepwebhook_redriveresourceobjectrequiredStructured resource values for this management operation.
Show 2 child fields
statusstringrequiredCurrent status of this resource or operation.
Allowed valuespendingrunningaction_requiredcancellingsucceededfailedcancelledsequenceintegerrequiredmin1formatint64Specifies sequence for this management operation.
capabilitiesobjectrequiredSpecifies capabilities for this management operation.
Show 2 child fields
progressobjectrequirednullableSpecifies progress for this management operation.
Show 3 child fields
resultstring or number or boolean or array or objectrequirednullableSpecifies result for this management operation.
One ofstring
errorobjectrequirednullableError details returned when the operation fails.
Show 3 child fields
actionRequiredobjectrequirednullableSpecifies action required for this management operation.
Show 2 child fields
createdAtstring (date-time)requiredISO 8601 timestamp when this resource was created.
updatedAtstring (date-time)requiredISO 8601 timestamp when this resource was last updated.
completedAtstring (date-time)requirednullableISO 8601 timestamp when this operation completed.
{
"id": "00000000-0000-4000-8000-000000000000",
"teamId": "00000000-0000-4000-8000-000000000000",
"projectId": "00000000-0000-4000-8000-000000000000",
"kind": "auth_projection_repair",
"resource": {
"type": "string",
"id": "string"
},
"status": "pending",
"sequence": 1,
"capabilities": {
"cancellable": true,
"watchable": true
},
"progress": {
"code": "string",
"current": 0,
"total": 0
},
"result": null,
"error": {
"code": "string",
"retryable": true,
"details": {}
},
"actionRequired": {
"code": "string",
"details": {}
},
"createdAt": "2026-09-22T12:00:00Z",
"updatedAt": "2026-09-22T12:00:00Z",
"completedAt": "2026-09-22T12:00:00Z"
}List operations
- Base URL
https://api.polymorfa.com- Required permission
operations:read
Lists asynchronous operations visible to the credential, newest first. Team keys and dashboard members see team-owned operations and every project's operations; supply projectId to return one project's operations. Project tokens see only their own project. Filter by status, kind, resource (resourceType and resourceId together), and creation time. A cursor carries the filters of the page that issued it and cannot be combined with new filters.
Requires operations:read. Project tokens only access resources in their own project.
Query parameters
projectIdstring (uuid)Identifier of the Polymorfa project that owns this resource.
statusstringCurrent status of this resource or operation.
Allowed valuespendingrunningaction_requiredcancellingsucceededfailedcancelledkindstringKind discriminator for this object.
Allowed valuesauth_projection_repairsession_lifecycleauth_session_purgelabel_projection_purgebilling_reconciliationauto_top_upcampaignproduction_enrollmentretention_sweepwebhook_redriveresourceTypestringType of resource affected by this event.
resourceIdstringIdentifier of the resource affected by this event.
sincestring (date-time)Specifies since for this query parameter.
untilstring (date-time)Specifies until for this query parameter.
limitintegerrange1–100Specifies limit for this query parameter.
Default25cursorstringSpecifies cursor for this query parameter.
Responses
200Success
dataarray of objectrequiredStructured data carried by this object.
Show 15 child fields
pageobjectrequiredSpecifies page for this schema.
Show 2 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/operations" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": [
{
"id": "00000000-0000-4000-8000-000000000000",
"teamId": "00000000-0000-4000-8000-000000000000",
"projectId": "00000000-0000-4000-8000-000000000000",
"kind": "auth_projection_repair",
"resource": {
"type": "string",
"id": "string"
},
"status": "pending",
"sequence": 1,
"capabilities": {
"cancellable": true,
"watchable": true
},
"progress": {
"code": "string",
"current": 0,
"total": 0
},
"result": null,
"error": {
"code": "string",
"retryable": true,
"details": {}
},
"actionRequired": {
"code": "string",
"details": {}
},
"createdAt": "2026-09-22T12:00:00Z",
"updatedAt": "2026-09-22T12:00:00Z",
"completedAt": "2026-09-22T12:00:00Z"
}
],
"page": {
"nextCursor": "string",
"hasMore": true
}
}List operation transitions
- Base URL
https://api.polymorfa.com- Required permission
operations:read
Lists immutable status transitions for one operation in ascending sequence.
Requires operations:read. Project tokens only access resources in their own project.
Path parameters
operationIdstring (uuid)requiredIdentifier used to retrieve the asynchronous operation.
Query parameters
projectIdstring (uuid)Identifier of the Polymorfa project that owns this resource.
afterSequenceintegermin0formatint64Specifies after sequence for this query parameter.
limitintegerrange1–100Specifies limit for this query parameter.
Default25cursorstringSpecifies cursor for this query parameter.
Responses
200Success
dataarray of objectrequiredStructured data carried by this object.
Show 7 child fields
pageobjectrequiredSpecifies page for this schema.
Show 2 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/operations/<operationId>/transitions" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": [
{
"operationId": "00000000-0000-4000-8000-000000000000",
"sequence": 1,
"fromStatus": "pending",
"toStatus": "pending",
"reasonCode": "string",
"occurredAt": "2026-09-22T12:00:00Z",
"snapshot": {
"progress": {
"code": "string",
"current": 0,
"total": 0
},
"error": {
"code": "string",
"retryable": true,
"details": {}
},
"actionRequired": {
"code": "string",
"details": {}
}
}
}
],
"page": {
"nextCursor": "string",
"hasMore": true
}
}List project operations
- Base URL
https://api.polymorfa.com- Required permission
operations:read
Lists asynchronous operations owned by the exact project in the route.
Requires operations:read. Project tokens only access resources in their own project.
Path parameters
projectIdstring (uuid)requiredIdentifier of the Polymorfa project that owns this resource.
Query parameters
statusstringCurrent status of this resource or operation.
Allowed valuespendingrunningaction_requiredcancellingsucceededfailedcancelledkindstringKind discriminator for this object.
Allowed valuesauth_projection_repairsession_lifecycleauth_session_purgelabel_projection_purgebilling_reconciliationauto_top_upcampaignproduction_enrollmentretention_sweepwebhook_redriveresourceTypestringType of resource affected by this event.
resourceIdstringIdentifier of the resource affected by this event.
sincestring (date-time)Specifies since for this query parameter.
untilstring (date-time)Specifies until for this query parameter.
limitintegerrange1–100Specifies limit for this query parameter.
Default25cursorstringSpecifies cursor for this query parameter.
Responses
200Success
dataarray of objectrequiredStructured data carried by this object.
Show 15 child fields
pageobjectrequiredSpecifies page for this schema.
Show 2 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/projects/<projectId>/operations" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": [
{
"id": "00000000-0000-4000-8000-000000000000",
"teamId": "00000000-0000-4000-8000-000000000000",
"projectId": "00000000-0000-4000-8000-000000000000",
"kind": "auth_projection_repair",
"resource": {
"type": "string",
"id": "string"
},
"status": "pending",
"sequence": 1,
"capabilities": {
"cancellable": true,
"watchable": true
},
"progress": {
"code": "string",
"current": 0,
"total": 0
},
"result": null,
"error": {
"code": "string",
"retryable": true,
"details": {}
},
"actionRequired": {
"code": "string",
"details": {}
},
"createdAt": "2026-09-22T12:00:00Z",
"updatedAt": "2026-09-22T12:00:00Z",
"completedAt": "2026-09-22T12:00:00Z"
}
],
"page": {
"nextCursor": "string",
"hasMore": true
}
}List project operation transitions
- Base URL
https://api.polymorfa.com- Required permission
operations:read
Lists immutable transitions for one project-owned operation in ascending sequence.
Requires operations:read. Project tokens only access resources in their own project.
Path parameters
projectIdstring (uuid)requiredIdentifier of the Polymorfa project that owns this resource.
operationIdstring (uuid)requiredIdentifier used to retrieve the asynchronous operation.
Query parameters
afterSequenceintegermin0formatint64Specifies after sequence for this query parameter.
limitintegerrange1–100Specifies limit for this query parameter.
Default25cursorstringSpecifies cursor for this query parameter.
Responses
200Success
dataarray of objectrequiredStructured data carried by this object.
Show 7 child fields
pageobjectrequiredSpecifies page for this schema.
Show 2 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/projects/<projectId>/operations/<operationId>/transitions" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": [
{
"operationId": "00000000-0000-4000-8000-000000000000",
"sequence": 1,
"fromStatus": "pending",
"toStatus": "pending",
"reasonCode": "string",
"occurredAt": "2026-09-22T12:00:00Z",
"snapshot": {
"progress": {
"code": "string",
"current": 0,
"total": 0
},
"error": {
"code": "string",
"retryable": true,
"details": {}
},
"actionRequired": {
"code": "string",
"details": {}
}
}
}
],
"page": {
"nextCursor": "string",
"hasMore": true
}
}Get account operation
- Base URL
https://api.polymorfa.com- Required permission
operations:read
Returns one asynchronous operation. Supply wait (0-30 seconds; 0 returns immediately) to hold the request until the operation reaches a terminal status (succeeded, failed, or cancelled), its sequence exceeds afterSequence, or the wait expires. The response is the operation's state at that moment; a 200 after an expired wait does not mean the operation finished. Operations outside the credential's team or project return 404.
Requires operations:read. Project tokens only access resources in their own project.
Path parameters
operationIdstring (uuid)requiredIdentifier used to retrieve the asynchronous operation.
Query parameters
projectIdstring (uuid)Identifier of the Polymorfa project that owns this resource.
waitintegerrange0–30Specifies wait for this query parameter.
Default0afterSequenceintegermin0formatint64Specifies after sequence for this query parameter.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 15 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/operations/<operationId>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"teamId": "00000000-0000-4000-8000-000000000000",
"projectId": "00000000-0000-4000-8000-000000000000",
"kind": "auth_projection_repair",
"resource": {
"type": "string",
"id": "string"
},
"status": "pending",
"sequence": 1,
"capabilities": {
"cancellable": true,
"watchable": true
},
"progress": {
"code": "string",
"current": 0,
"total": 0
},
"result": null,
"error": {
"code": "string",
"retryable": true,
"details": {}
},
"actionRequired": {
"code": "string",
"details": {}
},
"createdAt": "2026-09-22T12:00:00Z",
"updatedAt": "2026-09-22T12:00:00Z",
"completedAt": "2026-09-22T12:00:00Z"
}
}Get project operation
- Base URL
https://api.polymorfa.com- Required permission
operations:read
Returns one asynchronous operation owned by the exact project in the route. Supply wait (0-30 seconds; 0 returns immediately) to hold the request until the operation reaches a terminal status, its sequence exceeds afterSequence, or the wait expires.
Requires operations:read. Project tokens only access resources in their own project.
Path parameters
projectIdstring (uuid)requiredIdentifier of the Polymorfa project that owns this resource.
operationIdstring (uuid)requiredIdentifier used to retrieve the asynchronous operation.
Query parameters
waitintegerrange0–30Specifies wait for this query parameter.
Default0afterSequenceintegermin0formatint64Specifies after sequence for this query parameter.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 15 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
curl "https://api.polymorfa.com/platform/projects/<projectId>/operations/<operationId>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"data": {
"id": "00000000-0000-4000-8000-000000000000",
"teamId": "00000000-0000-4000-8000-000000000000",
"projectId": "00000000-0000-4000-8000-000000000000",
"kind": "auth_projection_repair",
"resource": {
"type": "string",
"id": "string"
},
"status": "pending",
"sequence": 1,
"capabilities": {
"cancellable": true,
"watchable": true
},
"progress": {
"code": "string",
"current": 0,
"total": 0
},
"result": null,
"error": {
"code": "string",
"retryable": true,
"details": {}
},
"actionRequired": {
"code": "string",
"details": {}
},
"createdAt": "2026-09-22T12:00:00Z",
"updatedAt": "2026-09-22T12:00:00Z",
"completedAt": "2026-09-22T12:00:00Z"
}
}Cancel operation
- Base URL
https://api.polymorfa.com- Required permission
operations:cancel
Requests cancellation after transactionally rechecking that the operation is cancellable. Only operations whose capabilities.cancellable is true accept cancellation: running or action-required campaign and production-enrollment operations. The operation moves to cancelling and later settles as cancelled or another terminal status. Other operations return 409 operation_conflict with the current operation. Retrying with the same Idempotency-Key replays the original receipt.
Requires operations:cancel. Project tokens only access resources in their own project.
Path parameters
operationIdstring (uuid)requiredIdentifier used to retrieve the asynchronous operation.
Headers
Idempotency-Keystringrequiredlength1–255Specifies idempotency key for this header parameter.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 3 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
409The operation cannot accept cancellation.
422The Idempotency-Key was already used for a different request.
curl -X POST "https://api.polymorfa.com/platform/operations/<operationId>/cancel" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Idempotency-Key: <idempotency_key>"{
"data": {
"operation": {
"id": "00000000-0000-4000-8000-000000000000",
"teamId": "00000000-0000-4000-8000-000000000000",
"projectId": "00000000-0000-4000-8000-000000000000",
"kind": "auth_projection_repair",
"resource": {
"type": "string",
"id": "string"
},
"status": "pending",
"sequence": 1,
"capabilities": {
"cancellable": true,
"watchable": true
},
"progress": {
"code": "string",
"current": 0,
"total": 0
},
"result": null,
"error": {
"code": "string",
"retryable": true,
"details": {}
},
"actionRequired": {
"code": "string",
"details": {}
},
"createdAt": "2026-09-22T12:00:00Z",
"updatedAt": "2026-09-22T12:00:00Z",
"completedAt": "2026-09-22T12:00:00Z"
},
"operationId": "00000000-0000-4000-8000-000000000000",
"idempotency": {
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"replayed": true,
"createdAt": "2026-09-22T12:00:00Z",
"expiresAt": "2026-09-22T12:00:00Z"
}
}
}Cancel project operation
- Base URL
https://api.polymorfa.com- Required permission
operations:cancel
Requests cancellation for an operation in the exact project after transactionally rechecking that it is cancellable.
Requires operations:cancel. Project tokens only access resources in their own project.
Path parameters
projectIdstring (uuid)requiredIdentifier of the Polymorfa project that owns this resource.
operationIdstring (uuid)requiredIdentifier used to retrieve the asynchronous operation.
Headers
Idempotency-Keystringrequiredlength1–255Specifies idempotency key for this header parameter.
Responses
200Success
dataobjectrequiredStructured data carried by this object.
Show 3 child fields
Show 3 headers
400A path, query, or request-body value did not pass validation.
401Missing/invalid credential for this audience.
403Authenticated but lacks the required scope/role/audience.
404The requested resource was not found inside the authenticated team or project scope.
409The operation cannot accept cancellation.
422The Idempotency-Key was already used for a different request.
curl -X POST "https://api.polymorfa.com/platform/projects/<projectId>/operations/<operationId>/cancel" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Idempotency-Key: <idempotency_key>"{
"data": {
"operation": {
"id": "00000000-0000-4000-8000-000000000000",
"teamId": "00000000-0000-4000-8000-000000000000",
"projectId": "00000000-0000-4000-8000-000000000000",
"kind": "auth_projection_repair",
"resource": {
"type": "string",
"id": "string"
},
"status": "pending",
"sequence": 1,
"capabilities": {
"cancellable": true,
"watchable": true
},
"progress": {
"code": "string",
"current": 0,
"total": 0
},
"result": null,
"error": {
"code": "string",
"retryable": true,
"details": {}
},
"actionRequired": {
"code": "string",
"details": {}
},
"createdAt": "2026-09-22T12:00:00Z",
"updatedAt": "2026-09-22T12:00:00Z",
"completedAt": "2026-09-22T12:00:00Z"
},
"operationId": "00000000-0000-4000-8000-000000000000",
"idempotency": {
"id": "00000000-0000-4000-8000-000000000000",
"key": "string",
"replayed": true,
"createdAt": "2026-09-22T12:00:00Z",
"expiresAt": "2026-09-22T12:00:00Z"
}
}
}