Segments

List segments

Get a list of segments for a specific org.

get/orgs/segments

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/segments
  • Auth: HTTP bearer

Query parameters

searchstring

Filter segments by name.

pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

Response

idstring required
namestring required
color'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral' required

Accent color, by name

contacts_countnumber required
created_atstring date-time required
updated_atstring date-time required

Changes

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