Home
/
REST API Reference
/
Segments
/
Segment

Segment

A segment is a group of your contacts defined by the rules that you set.

type
string

The type of object.

Value: "segment"
id
string

The unique identifier representing the segment.

name
string

The name of the segment.

created_at
integer

The time the segment was created.

updated_at
integer

The time the segment was updated.

person_type
string

Type of the contact: contact (lead) or user.

Enum: "contact" "user"
count
integer or null

The number of items in the user segment. It's returned when include_count=true is included in the request.

{
"type": "segment",
"id": "56203d253cba154d39010062",
"name": "Active",
"created_at": 1394621988,
"updated_at": 1394622004,
"person_type": "contact",
"count": 3
}