Skip to content
Home/
REST API Reference
/
/
Segment

Segment

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

typestring

The type of object.

Value:"segment"
Example:"segment"
idstring

The unique identifier representing the segment.

Example:"56203d253cba154d39010062"
namestring

The name of the segment.

Example:"Active"
created_atinteger

The time the segment was created.

Example:1394621988
updated_atinteger

The time the segment was updated.

Example:1394622004
person_typestring

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

Enum:"contact""user"
Example:"contact"
countinteger or null

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

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