Walks

curl https://theculpernetwork.com/api/v1/walks?limit=50 \
  -H "Authorization: Bearer culper_sk_live_…"

{
  "ok": true,
  "data": [
    {
      "id": "b7c3e9d2-1a4f-4c88-9e21-6f0a2b5d7c10",
      "name": "Riverstone — AM",
      "lat": 29.6011,
      "lng": -95.6339,
      "count": 42,
      "counts": {
        "not_visited": 30,
        "visited_home_answered": 7,
        "visited_no_answer": 3,
        "visited_left_lit": 1,
        "dropped_hanger": 1,
        "visited_refused": 0,
        "visited_wrong_address": 0,
        "visited_moved_away": 0
      },
      "web_url": "https://theculpernetwork.com/dashboard/alexander-hale-for-congress-y39t2rsm/walks/b7c3e9d2-1a4f-4c88-9e21-6f0a2b5d7c10",
      "app_link": "https://theculpernetwork.com/open/alexander-hale-for-congress-y39t2rsm/walks/b7c3e9d2-1a4f-4c88-9e21-6f0a2b5d7c10"
    }
  ],
  "meta": { "count": 1 }
}

curl https://theculpernetwork.com/api/v1/walks?limit=50 \
  -H "Authorization: Bearer culper_sk_live_…"

{
  "ok": true,
  "data": [
    {
      "id": "b7c3e9d2-1a4f-4c88-9e21-6f0a2b5d7c10",
      "name": "Riverstone — AM",
      "lat": 29.6011,
      "lng": -95.6339,
      "count": 42,
      "counts": {
        "not_visited": 30,
        "visited_home_answered": 7,
        "visited_no_answer": 3,
        "visited_left_lit": 1,
        "dropped_hanger": 1,
        "visited_refused": 0,
        "visited_wrong_address": 0,
        "visited_moved_away": 0
      },
      "web_url": "https://theculpernetwork.com/dashboard/alexander-hale-for-congress-y39t2rsm/walks/b7c3e9d2-1a4f-4c88-9e21-6f0a2b5d7c10",
      "app_link": "https://theculpernetwork.com/open/alexander-hale-for-congress-y39t2rsm/walks/b7c3e9d2-1a4f-4c88-9e21-6f0a2b5d7c10"
    }
  ],
  "meta": { "count": 1 }
}

Live. Requires the walks:read scope.

A walk is a route of door-to-door stops. These endpoints let you list a campaign’s walks and read the stops of any one walk.

List walks

GET /api/v1/walks

Returns the campaign’s active walks (archived and deleted walks are excluded).

Query parameters

integer

default:"50"

Maximum walks to return. Between 1 and 200.

Response

string

The walk’s unique id (use it with the detail endpoint).

string

Human-readable walk name.

number | null

Centroid latitude of the walk’s stops.

number | null

Centroid longitude of the walk’s stops.

integer

Total number of stops on the walk.

object

Stop counts broken down by status. Every status key is always present (0 when none). See stop statuses.

string

Link to open the walk in the Culper dashboard.

string

Universal link to open the walk in the mobile app (falls back to the web view when the app isn’t installed).

curl https://theculpernetwork.com/api/v1/walks?limit=50 \
  -H "Authorization: Bearer culper_sk_live_…"

{
  "ok": true,
  "data": [
    {
      "id": "b7c3e9d2-1a4f-4c88-9e21-6f0a2b5d7c10",
      "name": "Riverstone — AM",
      "lat": 29.6011,
      "lng": -95.6339,
      "count": 42,
      "counts": {
        "not_visited": 30,
        "visited_home_answered": 7,
        "visited_no_answer": 3,
        "visited_left_lit": 1,
        "dropped_hanger": 1,
        "visited_refused": 0,
        "visited_wrong_address": 0,
        "visited_moved_away": 0
      },
      "web_url": "https://theculpernetwork.com/dashboard/alexander-hale-for-congress-y39t2rsm/walks/b7c3e9d2-1a4f-4c88-9e21-6f0a2b5d7c10",
      "app_link": "https://theculpernetwork.com/open/alexander-hale-for-congress-y39t2rsm/walks/b7c3e9d2-1a4f-4c88-9e21-6f0a2b5d7c10"
    }
  ],
  "meta": { "count": 1 }
}

A campaign with no walks returns { "ok": true, "data": [], "meta": { "count": 0 } } — that’s a valid, successful response, not an error.

Get a walk

GET /api/v1/walks/{id}

Returns a single walk and its ordered stops. Returns 404 not_found if the walk doesn’t exist or isn’t part of your campaign.

Path parameters

string

required

The walk id from the list endpoint (a UUID).

Response

string

The walk’s id.

string

The walk’s name.

object[]

Ordered list of stops on the walk.

Show stop

string

The stop’s unique id.

number | null

Stop latitude.

number | null

Stop longitude.

string

Canvass result. See stop statuses.

integer

1-based order of the stop in the walk.

curl https://theculpernetwork.com/api/v1/walks/b7c3e9d2-1a4f-4c88-9e21-6f0a2b5d7c10 \
  -H "Authorization: Bearer culper_sk_live_…"

{
  "ok": true,
  "data": {
    "id": "b7c3e9d2-1a4f-4c88-9e21-6f0a2b5d7c10",
    "name": "Riverstone — AM",
    "stops": [
      { "id": "3f1a…", "lat": 29.6012, "lng": -95.6341, "status": "visited_home_answered", "position": 1 },
      { "id": "9c22…", "lat": 29.6014, "lng": -95.6338, "status": "not_visited", "position": 2 }
    ]
  }
}

{ "ok": false, "error": { "code": "not_found", "message": "Walk not found." } }

Stop statuses

counts keys and a stop’s status field use these values:

Status	Meaning
`not_visited`	Not yet canvassed.
`visited_home_answered`	Someone answered the door.
`visited_no_answer`	No one answered.
`visited_left_lit`	No answer; literature left.
`dropped_hanger`	Door hanger left.
`visited_refused`	Occupant declined to talk.
`visited_wrong_address`	Address was wrong / not found.
`visited_moved_away`	Voter no longer lives there.

Getting Started

Team

Targeting Voters

Block Walking

Campaign Progress

Outreach

Campaign Settings

API

List walks

Query parameters

Response

Get a walk

Path parameters

Response

Stop statuses

​List walks

​Query parameters

​Response

​Get a walk

​Path parameters

​Response

​Stop statuses

List walks

Query parameters

Response

Get a walk

Path parameters

Response

Stop statuses