List segments with optional campaign filter and pagination.

{
  "items": [
    {
      "id": 101,
      "campaignId": 1,
      "campaignName": "Spring Fundraiser 2024",
      "name": "Loyal Donors Segment",
      "description": "Donors who have contributed in the last 12 months",
      "code": "LOYAL-2024",
      "externalIdentifier": "SEG-2024-LOYAL",
      "totalDonors": 350,
      "totalGifts": 480,
      "totalGiftAmount": "125000.00",
      "averageGiftAmount": "260.42",
      "medianGiftAmount": "150.00",
      "highestGiftAmount": "5000.00",
      "totalVisitors": 1200,
      "conversionRate": "29.17%",
      "createdDateTime": "2024-01-15T09:30:00Z",
      "modifiedDateTime": "2024-04-10T16:45:00Z"
    }
  ],
  "total": 1
}

Authentication

Authorizationstring

JWT Authorization header using the Bearer scheme. Example: “Authorization: Bearer {token}”

Path parameters

campaignIdlongRequired

The optional campaign ID to filter segments.

Query parameters

FilterstringOptional

SkipintegerOptional

TakeintegerOptional

SortBystringOptional

DescendingbooleanOptional

IncludeDetailsbooleanOptional

Response

itemslist of objectsOptional

totalintegerOptional

Errors

400

Bad Request Error