API Reference

List Planned Jobs

List planned Rankhog jobs for an organization the actor can access. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

POST
/agent/v1/jobs/planned

List planned Rankhog jobs for an organization the actor can access. Cache policy: live. Idempotency: none. Auth modes: api_key, mcp_oauth, session_bearer.

Authorization

AuthorizationBearer <token>

Rankhog organization API key sent as Authorization: Bearer rhog_....

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/agent/v1/jobs/planned" \  -H "Content-Type: application/json" \  -d '{    "dateFrom": "2026-06-17T00:00:00.000Z",    "dateTo": "2026-06-24T00:00:00.000Z",    "organizationId": "org_2x9rnkhdemo",    "status": [      "scheduled",      "queued"    ],    "type": "reddit.execute_planned_action"  }'
[  {    "attempt": 1,    "cancelledAt": null,    "createdAt": "2026-06-17T11:45:00.000Z",    "createdByUserId": "usr_2x9rnkhdemo",    "error": null,    "failedAt": null,    "finishedAt": null,    "heartbeatAt": null,    "id": "job_2x9planned",    "managedRedditAccountId": "mra_2x9rnkhdemo",    "maxAttempts": 3,    "metadata": {      "source": "agentic_draft_approval"    },    "organizationId": "org_2x9rnkhdemo",    "parentJobId": null,    "progress": {      "message": "Waiting for Rankhog Desktop.",      "percent": 25    },    "publicInput": {      "plannedRedditActionId": "act_2x9rnkhdemo"    },    "result": null,    "scheduledAt": "2026-06-17T11:45:00.000Z",    "startedAt": null,    "state": {      "phase": "queued"    },    "status": "scheduled",    "type": "reddit.execute_planned_action",    "updatedAt": "2026-06-17T12:00:00.000Z",    "version": 1,    "websiteId": "site_2x9rnkhdemo"  }]
{  "error": {    "code": "agentic_invalid_input",    "details": {      "issues": [        {          "code": "invalid_type",          "message": "Expected string, received undefined.",          "path": [            "organizationId"          ]        }      ]    },    "message": "Request body did not match the agentic capability schema."  }}

{  "error": {    "code": "agentic_unauthorized",    "message": "Authenticate before using Rankhog agentic capabilities."  }}

{  "error": {    "code": "agentic_missing_scope",    "details": {      "missingScopes": [        "rankhog:read"      ]    },    "message": "Missing required OAuth scope: rankhog:read."  }}

{  "error": {    "code": "agentic_internal_error",    "message": "Rankhog could not complete this agentic request."  }}