BUbuttondown
Segments

Retrieve Segment

Changed on

Retrieve a specific segment by its ID

get/segments/{id}

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/segments/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

Response

OK

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

namestring required

A human-readable name for the segment.

descriptionstring required

An optional free-form description of the segment, shown alongside its name when picking an email's audience.

Changes