PRprivy
Segments

Get a segment

Changed on

Retrieve a single segment by its identifier. The members themselves are /v1/segments/{id}/contacts. A campaign's audience segment ids resolve here when the segment was saved to the account. There is no per-segment performance report anywhere in the API.

Required scope: segments_read

get/segments/{id}

Request

  • Base URL
    https://api.privy.com/v1
  • Auth
    HTTP bearer

Path parameters

idstring required

The segment's unique identifier (returned as id in segment responses). Ids are opaque public strings — a numeric id from a Privy dashboard URL is not a valid API id and will 404; list segments and match by name instead.

Headers

Privy-Account-Idstring

Target a subaccount instead of the main connected account. Pass a subaccount id from get_account's subaccounts list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself.

Response

The segment.

Example response

{
  "data": {
    "id": "Rz5T2kW8pB",
    "name": "VIP Customers",
    "total_count": 1930,
    "mailable_count": 1240,
    "textable_count": 315,
    "counts": {
      "refreshed_at": "2026-06-15T08:00:00Z",
      "freshness": "Counts are refreshed periodically and may be up to an hour old."
    },
    "created_at": "2026-03-01T10:00:00Z",
    "updated_at": "2026-06-01T10:00:00Z"
  }
}

Changes

  • bc29b48dcdd2Revision changes
    • info

      added the optional property ///// to the response with the status

  • cf0885e90d5aRevision changes
    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status