Skip to main content
GET
Retrieve a segment by ID.

Autorisations

Authorization
string
header
requis

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.

Paramètres de chemin

segment-id
string
requis

The external ID of the segment.

Réponse

Successful Response

name
string
requis

Name of the segment.

Maximum string length: 64
description
string | null
requis

Description of the segment.

Maximum string length: 400
id
string
requis

ID of the segment.

total
integer
requis

User count of the segment.