Operations

List operations

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.

GET

platform

operations

List operations

curl --request GET \
  --url https://api.polymorfa.com/platform/operations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/operations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/operations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "auth_projection_repair",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      },
      "status": "pending",
      "sequence": 2,
      "capabilities": {
        "cancellable": true,
        "watchable": true
      },
      "progress": {
        "code": "<string>",
        "current": 123,
        "total": 123
      },
      "result": null,
      "error": {
        "code": "<string>",
        "retryable": true,
        "details": {}
      },
      "actionRequired": {
        "code": "<string>",
        "details": {}
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Query Parameters

projectId

string<uuid>

Identifier of the Polymorfa project that owns this resource.

Value constraints

Constraint	Accepted input
Format	`uuid`
Return only this project's operations. Project tokens may pass only their own project.

status

enum<string>

Current status of this resource or operation.

Allowed values

Value	Meaning
`pending`	Pending.
`running`	Running.
`action_required`	Action required.
`cancelling`	Cancelling.
`succeeded`	Succeeded.
`failed`	Failed.
`cancelled`	Cancelled.

Available options:

pending,

running,

action_required,

cancelling,

succeeded,

failed,

cancelled

kind

enum<string>

Kind discriminator for this object.

Allowed values

Value	Meaning
`auth_projection_repair`	Auth projection repair.
`session_lifecycle`	Session lifecycle.
`auth_session_purge`	Auth session purge.
`label_projection_purge`	Label projection purge.
`billing_reconciliation`	Billing reconciliation.
`auto_top_up`	Auto top up.
`campaign`	Campaign.
`production_enrollment`	Production enrollment.
`retention_sweep`	Retention sweep.
`webhook_redrive`	Webhook redrive.

Available options:

auth_projection_repair,

session_lifecycle,

auth_session_purge,

label_projection_purge,

billing_reconciliation,

auto_top_up,

campaign,

production_enrollment,

retention_sweep,

webhook_redrive

resourceType

string

Type of resource affected by this event.

resourceId

string

Identifier of the resource affected by this event.

since

string<date-time>

Specifies since for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`

until

string<date-time>

Specifies until for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`

limit

integer

default:25

Specifies limit for this query parameter.

Value constraints

Constraint	Accepted input
Numeric value	`1` through `100` (inclusive)

Required range: 1 <= x <= 100

cursor

string

Specifies cursor for this query parameter.

Response

Success

data

object[]

required

Structured data carried by this object.

Show child attributes

page

object

required

Specifies page for this schema.

Show child attributes

List operations

curl --request GET \
  --url https://api.polymorfa.com/platform/operations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/operations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/operations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "auth_projection_repair",
      "resource": {
        "type": "<string>",
        "id": "<string>"
      },
      "status": "pending",
      "sequence": 2,
      "capabilities": {
        "cancellable": true,
        "watchable": true
      },
      "progress": {
        "code": "<string>",
        "current": 123,
        "total": 123
      },
      "result": null,
      "error": {
        "code": "<string>",
        "retryable": true,
        "details": {}
      },
      "actionRequired": {
        "code": "<string>",
        "details": {}
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "page": {
    "nextCursor": "<string>",
    "hasMore": true
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

List operations

Authorizations

Query Parameters

Response