ONE directory:get
← Receivers

directory:get

directory family

Read one directory submission run for a workspace. view 'queue': the run's rows — the latest run by default, queued rows by default, each with its frozen pack; says when it is short (total, capped)

Effect
ask
Awaits an outcome — the call returns the response below.
Caller
manage_integrations
The class of authority the caller must already hold, decided from the attested context with no round trip.
Authority action
manage_integrations
Also gated per node — the caller must be permitted this action over the workspace it names.
Cost
free
What one call costs, so you can budget before acting.
Reversible
yes
The effect can be undone by a later call.
Idempotent
yes
Safe to retry as-is.
Version
1.0.0
Pin this to keep a contract stable; additive bumps never break callers.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code
Codex
Cursor
Gemini CLI
Claude Desktop
ChatGPT
curl -X POST https://one.ie/api/ask/directory:get \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "view": "queue", "status": "queued", "limit": 10 }}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

  • view queue required queue = one run's rows with their frozen packs
  • workspace string optional Workspace slug; defaults to the attested caller's. Authority is derived from the attested context, never from this field alone — a slug you do not control is refused.
  • runId string optional The run to read. Omit for the workspace's latest run, as the board shows it. Another workspace's runId reads as an empty run.
  • status string optional queued (default) | submitted | live | rejected | any. Anything else is refused as bad_status.
  • limit number optional Rows to return, 1-100, default 20. total and capped say whether more exist.

Response

What comes back from the call.

  • ok boolean
  • runId string | null The run read; null when the workspace has no run yet
  • rows object[]
  • total number Every row of this run with this status, not only those returned
  • capped boolean true when rows.length < total — raise limit to read the rest
  • error string no_db | workspace required | forbidden | bad_view | bad_status | bad_limit

Traffic

Every call to directory:get, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names directory:get, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

API route 1
  • one.ie/web/src/lib/receiver-index.generated.ts:137
CLI 1
  • packages/cli/src/directories.ts:104
→

Answered by

directory:get one.ie/web/src/lib/resolvers/directories.ts:96 Dispatched through POST /api/ask/directory:get, after the envelope validates the payload.

directory family · 3 more

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "view": {
      "type": "string",
      "enum": [
        "queue"
      ],
      "description": "queue = one run's rows with their frozen packs"
    },
    "workspace": {
      "description": "Workspace slug; defaults to the attested caller's. Authority is derived from the attested context, never from this field alone — a slug you do not control is refused.",
      "type": "string"
    },
    "runId": {
      "description": "The run to read. Omit for the workspace's latest run, as the board shows it. Another workspace's runId reads as an empty run.",
      "type": "string"
    },
    "status": {
      "description": "queued (default) | submitted | live | rejected | any. Anything else is refused as bad_status.",
      "type": "string"
    },
    "limit": {
      "description": "Rows to return, 1-100, default 20. total and capped say whether more exist.",
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "view"
  ]
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "runId": {
      "description": "The run read; null when the workspace has no run yet",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The directory_submissions row id — what directory:update takes"
          },
          "directorySlug": {
            "type": "string",
            "description": "The registry slug — directory:list gives its submitUrl and fields"
          },
          "status": {
            "type": "string"
          },
          "pack": {
            "description": "The frozen SubmissionPack { fields, missing } written at run time; null when it was not written or will not parse"
          },
          "listingUrl": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "note": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "directorySlug",
          "status",
          "pack",
          "listingUrl",
          "note"
        ]
      }
    },
    "total": {
      "description": "Every row of this run with this status, not only those returned",
      "type": "number"
    },
    "capped": {
      "description": "true when rows.length < total — raise limit to read the rest",
      "type": "boolean"
    },
    "error": {
      "description": "no_db | workspace required | forbidden | bad_view | bad_status | bad_limit",
      "type": "string"
    }
  },
  "required": [
    "ok"
  ]
}