sdkDeterministic

List segments

Name: Pipeline
Price: 99 USD

pipeline.listSegments

List the workspace GTM segments available in Launchpad so the operator can choose an exact segment before creating or reusing a campaign brief. Never guess when multiple segments are returned.

Parameters

workspaceIdrequired

string

No description.

includeArchived

boolean

No description.

Example

TypeScripttypescript

await pipeline.listSegments({
  "workspaceId": "00000000-0000-4000-8000-000000000000"
})

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "segments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "workspaceId": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "icon": {
            "type": [
              "string",
              "null"
            ]
          },
          "color": {
            "type": [
              "string",
              "null"
            ]
          },
          "valueProp": {
            "type": [
              "string",
              "null"
            ]
          },
          "pain": {
            "type": [
              "string",
              "null"
            ]
          },
          "criteria": {
            "type": "object"
          },
          "exampleAccounts": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                }
              },
              "required": [
                "name"
              ]
            }
          },
          "personaIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "icpProfileId": {
            "type": [
              "string",
              "null"
            ]
          },
          "weight": {
            "type": "number"
          },
          "estimatedLeads": {
            "type": [
              "number",
              "null"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "active",
              "archived"
            ]
          },
          "briefId": {
            "type": [
              "string",
              "null"
            ]
          },
          "tableId": {
            "type": [
              "string",
              "null"
            ]
          },
          "campaignId": {
            "type": [
              "string",
              "null"
            ]
          },
          "generatedByAgentRunId": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdBy": {
            "type": "string"
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "workspaceId",
          "name",
          "slug",
          "icon",
          "color",
          "valueProp",
          "pain",
          "criteria",
          "exampleAccounts",
          "personaIds",
          "icpProfileId",
          "weight",
          "estimatedLeads",
          "status",
          "briefId",
          "tableId",
          "campaignId",
          "generatedByAgentRunId",
          "createdBy",
          "createdAt",
          "updatedAt"
        ]
      }
    }
  },
  "required": [
    "segments"
  ]
}

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.