Segments

Retrieve a segment

Retrieve a single segment by id, including its name and member count. To page through the contacts inside it, use List segment members. Requires the segments:read capability.

get/segments/{id}

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/segments/{id}
  • Auth: HTTP bearer

Response

The segment.

object'segment' required
idstring required
namestring required
descriptionstring nullable required
type'static' | 'dynamic' required
filterSchema0 required(unresolved $ref)
created_atstring required
updated_atstring required

Changes

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