Skip to main content
GET
Retrieve a segment by ID.

Authorizations

Authorization
string
header
required

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Path Parameters

segment-id
string
required

The external ID of the segment.

Response

Successful Response

name
string
required

Name of the segment.

Maximum string length: 64
description
string | null
required

Description of the segment.

Maximum string length: 400
id
string
required

ID of the segment.

total
integer
required

User count of the segment.