User

Get segment

get/api/v1/user/segments/{id}

Path parameters

idinteger required

Response

Segment

idinteger

user_idinteger

namestring

descriptionstring

filters_jsonstring

filtersUserSegmentStoredFilters

Read-only decoded filters_json from an existing segment. New writes must use UserSegmentFilters. Historic records may still contain removed keys such as forma or estado; clients must present them as unavailable and execution fails closed rather than ignoring them.

personastring nullable

iconstring nullable

created_atstring

updated_atstring

Changes

Changed in 1 of the 3 revisions of this API.36

Jul 26, 2026996f96a1175836See the full diff
- ○
  api operation id getUserSegmentsById was added
  api-operation-id-added
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
- ○
  added the optional property _alias_of to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property action to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property allowed to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property allowed_parameters to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property daily_limit to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property date to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property detail to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property fields to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property key to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property limit to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property limited_by to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property login_url to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property max_bytes to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property maximum to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property needed to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property ok to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property parameter to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property plan to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property projection to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property reason to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property remaining to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property reset_at to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property reset_at_human to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property retry_after to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property retry_after_s to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property shortfall to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property slug to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property source_catalog_version to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property status to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property upgrade to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property upgrade_url to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property valid to the response with the 404 status
  response-optional-property-added
- ○
  the response property error became required for the status 404
  response-property-became-required
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history