Skip to main content

Admin endpoints

These endpoints are for admin use: monitoring and recovering from failures. All under /v1/workspaces/:workspaceId. Auth: Bearer + x-workspace-id; admin role required.

GET /v1/workspaces/:workspaceId/admin/queue-metrics​

Get queue metrics (depth, throughput, etc.) for background job queues.

Response (200): Object with queue names and metrics.

Example:

curl -X GET https://api.inboxops.app/v1/workspaces/ws-123/admin/queue-metrics \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123"

GET /v1/workspaces/:workspaceId/admin/jobs​

List recent jobs (e.g. ingestion, sync, outbound). Optional query: limit (1–500).

Response (200): Array of job objects (id, type, state, createdAt, etc.).

Example:

curl -X GET "https://api.inboxops.app/v1/workspaces/ws-123/admin/jobs?limit=50" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123"

POST /v1/workspaces/:workspaceId/admin/jobs/:jobId/retry​

Retry a failed job.

Response (200): Updated job or success.

Example:

curl -X POST https://api.inboxops.app/v1/workspaces/ws-123/admin/jobs/JOB_UUID/retry \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123"

GET /v1/workspaces/:workspaceId/admin/connectors/imap-health​

Get IMAP connector health (if IMAP is used). Other connectors may have similar endpoints.

Response (200): Health status object.

Example:

curl -X GET https://api.inboxops.app/v1/workspaces/ws-123/admin/connectors/imap-health \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123"

Users and audit logs (workspace access)​

  • GET .../users — List users in the workspace. Optional query: limit (1–100).
  • GET .../audit-logs — List audit log entries. Optional query: limit (1–100). Admin typically required.

Example (audit logs):

curl -X GET "https://api.inboxops.app/v1/workspaces/ws-123/audit-logs?limit=20" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "x-workspace-id: ws-123"

Creating audit log entries is usually internal or restricted; the public API focuses on listing for admins.