Bellwork
Book a demo
OrgSequences

List the organization's outreach sequences

Every sequence the org has drawn, newest first, with how many steps each one has and how many contacts are currently moving through it. Gated by the `sequencer` module; otherwise responds 403 module_required.

GET
/org/sequences

Every sequence the org has drawn, newest first, with how many steps each one has and how many contacts are currently moving through it. Gated by the sequencer module; otherwise responds 403 module_required.

Authorization

AuthorizationBearer <token>

API key (sk_live_... prefix). Generate keys in the UI under Settings > API Keys, then send it as Authorization: Bearer sk_live_...

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://loading/api/v1/org/sequences"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "status": "draft",
      "entry_node_id": "309c9c20-703c-4647-be34-6fd6edeb7c28",
      "send_window_start": "string",
      "send_window_end": "string",
      "send_timezone": "string",
      "send_on_weekends": true,
      "one_per_district": true,
      "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
      "table_id": "ac92386a-00cc-4818-bf43-1a666d5a5e67",
      "table_name": "string",
      "max_sends_per_enrollment": -9007199254740991,
      "created_at": "string",
      "updated_at": "string",
      "node_count": -9007199254740991,
      "active_enrollments": -9007199254740991,
      "to_review": -9007199254740991
    }
  ]
}
{
  "error": "string",
  "message": "string",
  "statusCode": -9007199254740991
}
{
  "error": "module_required",
  "module": "string",
  "message": "string",
  "contact": "string"
}

Approve or remove one person POST

`approve` hands this person's plan to the clock: the step they are standing on goes out in the sequence's sending hours, spaced by the account's limits, and every later step follows on schedule exactly as the plan was left. It does not send anything itself. `remove` takes them out of the sequence and nothing is ever sent. Keyed on the enrollment, so a second press finds it already dealt with and says so.

Start a new sequence POST

Creates an empty sequence in `draft`. The canvas fills in the steps and arrows, then saves them with PUT. `org_id` and `created_by` are always taken from the session, never the request body.