Skip to main content

PaginatedResponse[StageRead]

items object[]required
  • Array [
    • idIdrequired

    Unique numeric identifier of the record.

    product_idProduct Idrequired

    ID of the product (workspace) that owns this record. Most endpoints scope access by product.

    nameNamerequired

    Human-readable stage name.

    positionPositionrequired

    Ordering of the stage within the pipeline (lower comes first).

    analytics_role object

    Role of the stage in funnel analytics — entry, progress, terminal, or ignore.

    anyOf
    StageAnalyticsRole

    Possible values: [entry, progress, terminal, ignore]

    analytics_outcome object

    For terminal stages, the business outcome — success, escalation, refusal, disqualified, or other.

    anyOf
    StageAnalyticsOutcome

    Possible values: [success, escalation, refusal, disqualified, other]

    created_atdate-timerequired

    Creation time (UTC, ISO 8601).

  • ]
    • pagePagerequired
    limitLimitrequired
    totalTotalrequired
    pagesPagesrequired
    PaginatedResponse[StageRead]
    {
      "items": [
        {
          "id": 0,
          "product_id": 0,
          "name": "string",
          "position": 0,
          "analytics_role": "entry",
          "analytics_outcome": "success",
          "created_at": "2024-07-29T15:51:28.071Z"
        }
      ],
      "page": 0,
      "limit": 0,
      "total": 0,
      "pages": 0
    }