Get a segment

Returns one saved segment from the authenticated workspace.

get/v1/segments/{segment_id}

Request

Base URL: https://api.mailrith.com
URL: https://api.mailrith.com/v1/segments/{segment_id}
Auth: HTTP bearer

Path parameters

segment_idstring required

The identifier of the segment to return.

Response

Successful response

Example response

{
  "data": {
    "definition": {
      "match": "all",
      "groups": [
        {
          "id": "active-subscribers",
          "match": "all",
          "conditions": [
            {
              "id": "active-status",
              "field": "subscriber_status",
              "operator": "is",
              "value": [
                "Active"
              ]
            }
          ]
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.