Skip to main content
GET
/
v2
/
sequences
List sequences
curl --request GET \
  --url https://api.village.do/v2/sequences \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "sequences": [
      {
        "id": "MLVEUadsfgzdsafsc10q5g%3D%3D!vNnNM",
        "name": "Cold Outreach – Founders in SaaS",
        "description": "3-step intro sequence for early-stage SaaS founders",
        "status": "active",
        "ai_instructions": "You are a helpful SDR. Keep emails under 120 words...",
        "ai_email_templates": [
          {
            "id": 1,
            "name": "Ask for Introduction",
            "use_case": "sales",
            "used_for": "Use when you have a warm introducer available",
            "subject": "Quick intro request?",
            "email_body": "Hi {introducer_name}..."
          }
        ],
        "total_leads": 25,
        "open_rate": 68,
        "reply_rate": 12,
        "click_rate": 8,
        "forward_rate": 3
      }
    ],
    "pagination": {
      "cursor": "<string>",
      "has_next_page": true,
      "count": 1
    }
  },
  "metadata": {
    "request_id": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Use the API token from your personal Village account: https://village.do/settings#api-keys

For verified apps accessing user data, create a user token: https://docs.village.do/api-reference-v2/authentication/create-authorization

Query Parameters

status
enum<string>

Sequence status

Available options:
draft,
active,
paused,
archived
Example:

"active"

limit
integer
default:20
Required range: 1 <= x <= 100
cursor
integer | null
default:0
Required range: x >= 0
Maximum string length: 255

Response

Sequences retrieved successfully

data
object
required

Response containing list of sequences with pagination

metadata
object
required