at.happyproto.admin.listJobs

happyproto.at

Documentation

Background jobs across every user, newest first. Staff only.

main query

Background jobs across every user, newest first. Staff only.

Parameters

jobType string Optional

Only jobs of this type.

limit integer Optional

No description available.

status string Optional

Comma-separated statuses to include. Defaults to pending,running,pausing,cancelling.

Output

Encodingapplication/json
jobs array Required

No description available.

Errors

AuthRequired This endpoint requires an authenticated caller.
Forbidden The caller is not HappyProto staff.
InvalidRequest status names an unknown status, or limit is not a whole number from 1 to 200.
Upstream The jobs could not be read.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Only jobs of this type.
Comma-separated statuses to include. Defaults to pending,running,pausing,cancelling.
View raw schema 
{
  "description": "Background jobs across every user, newest first. Staff only.",
  "errors": [
    {
      "description": "This endpoint requires an authenticated caller.",
      "name": "AuthRequired"
    },
    {
      "description": "The caller is not HappyProto staff.",
      "name": "Forbidden"
    },
    {
      "description": "status names an unknown status, or limit is not a whole number from 1 to 200.",
      "name": "InvalidRequest"
    },
    {
      "description": "The jobs could not be read.",
      "name": "Upstream"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "jobs": {
          "items": {
            "ref": "#adminJob",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "jobs"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "jobType": {
        "description": "Only jobs of this type.",
        "type": "string"
      },
      "limit": {
        "default": 50,
        "maximum": 200,
        "minimum": 1,
        "type": "integer"
      },
      "status": {
        "description": "Comma-separated statuses to include. Defaults to pending,running,pausing,cancelling.",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}
adminJob object

A background job as staff see it. Never carries its input or session fields.

Properties

completedAt string datetime Optional

An RFC 3339 formatted timestamp.

createdAt string datetime Required

An RFC 3339 formatted timestamp.

createdBy string did Required

Who started it.

error string Optional

Why the job failed, as the job reported it.

id string Required

A UUID.

jobType string Required

No description available.

progress unknown Optional

The job's last progress report.

result unknown Optional

What the job returned, once completed.

startedAt string datetime Optional

An RFC 3339 formatted timestamp.

status string Required

No description available.

Known values: pending, running, paused, pausing, cancelling, completed, failed, cancelled
View raw schema 
{
  "description": "A background job as staff see it. Never carries its input or session fields.",
  "properties": {
    "completedAt": {
      "format": "datetime",
      "type": "string"
    },
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "createdBy": {
      "description": "Who started it.",
      "format": "did",
      "type": "string"
    },
    "error": {
      "description": "Why the job failed, as the job reported it.",
      "type": "string"
    },
    "id": {
      "description": "A UUID.",
      "type": "string"
    },
    "jobType": {
      "type": "string"
    },
    "progress": {
      "description": "The job's last progress report.",
      "type": "unknown"
    },
    "result": {
      "description": "What the job returned, once completed.",
      "type": "unknown"
    },
    "startedAt": {
      "format": "datetime",
      "type": "string"
    },
    "status": {
      "knownValues": [
        "pending",
        "running",
        "paused",
        "pausing",
        "cancelling",
        "completed",
        "failed",
        "cancelled"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "jobType",
    "createdBy",
    "createdAt"
  ],
  "type": "object"
}

Lexicon Garden

@