v1

latestOpenAPI 3.1.02026-07-26497885.9 KB

View segment

Retrieve details for a single segment by its ID, including subscriber count and optionally segment metadata and filters.

get/apps/{app_id}/segments/{segment_id}

Path parameters

app_idstring required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

segment_idstring required

The segment's unique identifier. Can be found using the View segments API or in the dashboard URL.

Query parameters

include-segment-detailboolean

Set to true to include segment metadata and filters in the response.

Headers

Authorizationstring required

Your App API key with prefix Key . See Keys & IDs.

Response

200

subscriber_countinteger

The number of subscribers matching this segment.