Docs
Workspace

One async job

GEThttps://api.norreach.app/v1/jobs/{id}

The status of a job an earlier request started — plan generation from POST /briefs, a re-plan from POST /plans/{id}/replan. Poll until status is succeeded (its result holds the answer, e.g. the plan id) or failed (its error is a problem). resource names what the job works on. Webhook subscribers get plan.generated when Nora finishes writing a plan.

Any keyOperation id: get_job
GET/jobs/{id}
curl -X GET "https://api.norreach.app/v1/jobs/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY"
One async job
{
  "id": "2f9c1a7e-5b3d-4e8f-9a1b-6c7d8e9f0a1b",
  "object": "job",
  "type": "plan.generate",
  "status": "succeeded",
  "created_at": "2026-11-04T09:12:33.120Z",
  "finished_at": "2026-11-04T09:16:41.004Z",
  "result": {
    "plan_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
    "plan_status": "review"
  },
  "error": null,
  "resource": {
    "object": "plan",
    "id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d"
  }
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. Any valid key works. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Response

200application/json— One async job

idstring (uuid)required

An id (UUID).

object"job"required
typestringrequired

What the job does (e.g. contacts.import).

statusenumrequired
One of:queuedrunningsucceededfailed
created_atstringrequired

RFC 3339 UTC timestamp with milliseconds.

finished_atstring | nullrequired
resultany | nullrequired

The job's answer once it succeeded.

errorobject | nullrequired

Why it failed.

resourceobject | null

What the job works on — GET it for the full object.

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
404not_foundThat doesn't exist.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.