Segments

Details on APIs that can be used to pull information on Segments created in CustomerSuccessBox

Check available Segment APIs on the left-hand navigation bar.

Resources

Field

Data Type

Read Only

Context

Format

id

integer

​☑​

ID generated by CSB to uniquely identify the Segment

​

name

string

​☑​

Name of the Segment entered in CSB

​

created_at

date

​☑​

Date when the Segment was created in CSB

​

updated_at

date

​☑​

Date when the Segment was updated in CSB

​

limit

integer

​☑​

Maximum number of records that will be returned in that page. The limit is 20

​

page

integer

​☑​

Page number of the paginated API call response

​

total

integer

​☑​

Total number of records returned in that page

​

account_id

integer

​☑​

ID generated by CSB to uniquely identify the account

​

external_account_id

string

​☑​

A unique immutable identifier for the account stored in CSB. This id case-sensitive

​