Skip to main content
GET
Retrieve a segment by ID.

Autorizações

Authorization
string
header
obrigatório

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.

Parâmetros de caminho

segment-id
string
obrigatório

The external ID of the segment.

Resposta

Successful Response

name
string
obrigatório

Name of the segment.

Maximum string length: 64
description
string | null
obrigatório

Description of the segment.

Maximum string length: 400
id
string
obrigatório

ID of the segment.

total
integer
obrigatório

User count of the segment.