Skip to main content
GET
https://prod-api.raisedonors.com
/
api
/
Segment
/
list
/
{campaignId}
List All Segments
curl --request GET \
  --url https://prod-api.raisedonors.com/api/Segment/list/{campaignId} \
  --header 'Authorization: <api-key>'
{
  "items": [
    {
      "id": 123,
      "campaignId": 123,
      "campaignName": "<string>",
      "name": "<string>",
      "description": "<string>",
      "code": "<string>",
      "externalIdentifier": "<string>",
      "totalDonors": 123,
      "totalGifts": 123,
      "totalGiftAmount": "<string>",
      "averageGiftAmount": "<string>",
      "medianGiftAmount": "<string>",
      "highestGiftAmount": "<string>",
      "totalVisitors": 123,
      "conversionRate": "<string>",
      "createdDateTime": "<string>",
      "modifiedDateTime": "<string>"
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

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

Path Parameters

campaignId
integer<int64>
required

The optional campaign ID to filter segments.

Query Parameters

Filter
string
Skip
integer<int32>
Take
integer<int32>
SortBy
string
Descending
boolean
IncludeDetails
boolean

Response

OK

items
object[]
total
integer<int32>
Last modified on June 5, 2026