Sign in
latestOpenAPI 3.1.02026-08-10295186.7 KB

ec696334ff35

Segments

List

List segments

get/segments/list

Query parameters

fromstring

A cursor for pagination accross multiple pages of results. Don't include this parameter on the first call. Use the next_from value returned in a previous response to request subsequent resutls.

limitinteger

A limit on the number of objects to be returned.

Headers

X-Batch-Projectstring required

The unique project key, identifying a project on the Batch platform

Response

If the GET to the API endpoint is successful you will receive an HTTP 200 confirmation and information about you segments.

countinteger

The total number of objects.

has_moreboolean

Whether or not there are more elements available after this set. If false, this set comprises the end of the list.

next_fromstring

A cursor for use in pagination. If has_more is true, you can pass the value of next_from to a subsequent call to fetch the next page of resutls.