One plan card

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

One card of a plan: its words, why it is there, its state, what holds it and the claims in it that were checked.

plans:readOperation id: get_plan_card

GET/cards/{id}

curl -X GET "https://api.norreach.app/v1/cards/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

One plan card

{
  "id": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
  "object": "plan_card",
  "plan_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "date": "2026-11-12",
  "time_label": "09:30",
  "scheduled_at": null,
  "channel": "email",
  "arc_stage": "awareness",
  "title": "Intro to clinic managers",
  "what": {
    "kind": "email",
    "subject": "Nurses for the winter",
    "body": "Hi {{first_name}}, …"
  },
  "why": "Clinic managers plan staffing a month ahead.",
  "chain": "Opens feed the follow-up on day 4.",
  "state": "awaiting_approval",
  "conditional": false,
  "cost_class": "free",
  "approved_at": null,
  "hold": "policy",
  "claims": [],
  "outcome": null
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope plans:read. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Response

200application/json— One plan card

idstring (uuid)required

An id (UUID).

object"plan_card"required

plan_idstring (uuid)required

An id (UUID).

datestringrequired

time_labelstringrequired

scheduled_atstring | nullrequired

channelstringrequired

arc_stageenumrequired

One of:curiosityawarenessconsiderationproofofferurgencydecision

titlestringrequired

whatobjectrequired

The card's words, by kind: email (subject, body), message (text), post (caption), call (opening), ad (primary …).

whystringrequired

chainstringrequired

stateenumrequired

One of:queuedawaiting_approvalrunningcompletedskippedfailed

conditionalbooleanrequired

Fires on the lead's own behaviour rather than at a set time.

cost_classenumrequired

One of:freelowhighcustomer

approved_atstring | nullrequired

holdenum | nullrequired

Why it waits: policy (your plan's settings), claim (a claim needs checking — decide it in the app), state (the lead's own state).

claimsobject[]required

Show child attributes

claims[].claimstringrequired

claims[].statusenumrequired

One of:flaggedsourced

claims[].sourcestring | nullrequired

outcomeobject | nullrequired

Errors

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

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
404	`not_found`	That doesn't exist.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

GET/cards/{id}

curl -X GET "https://api.norreach.app/v1/cards/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY"

One plan card

{
  "id": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
  "object": "plan_card",
  "plan_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "date": "2026-11-12",
  "time_label": "09:30",
  "scheduled_at": null,
  "channel": "email",
  "arc_stage": "awareness",
  "title": "Intro to clinic managers",
  "what": {
    "kind": "email",
    "subject": "Nurses for the winter",
    "body": "Hi {{first_name}}, …"
  },
  "why": "Clinic managers plan staffing a month ahead.",
  "chain": "Opens feed the follow-up on day 4.",
  "state": "awaiting_approval",
  "conditional": false,
  "cost_class": "free",
  "approved_at": null,
  "hold": "policy",
  "claims": [],
  "outcome": null
}