Segmentation

Get Segments

Changed on
get/v1/segments

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/segments
  • Auth
    HTTP bearer

Query parameters

segment_group_idstring
limitinteger

A limit on the number of objects to be returned

offsetinteger

The number of objects to skip

Response

Successful Response

slugstring required
namestring required
descriptionstring
colorstring
image_urlstring uri
segment_group_idstring
idstring required

Changes

  • 0ef278347679Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • fb9750c99d0aRevision changes
    • warning

      for the query request parameter limit, the exclusiveMinimum was set to 1.00

    • warning

      for the query request parameter segment_group_id, the maxLength was set to 32

    • warning

      for the query request parameter limit, the max was set to 300.00

    • warning

      for the query request parameter offset, the min was set to 0.00