Segment - All records
GET /segments/v2/{bucket}/segment/{uid}/all
GET
/segments/v2/{bucket}/segment/{uid}/all
Segments are groups of records that can be used for browsing or bulk actions. This endpoint returns a list of all the records in the segment.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” bucket
required
The bucket (client) name
string
Example
example uid
required
Usually the final element in the URI, an alphanumeric unique identifier
string
Example
6305f074683e800f3abe809eQuery Parameters
Section titled “Query Parameters ” q
string
Example
john smith page_size
The number of items to return per page, usually used in conjunction with page to paginate a list of items
number
Example
10 page
A page number, usually used in conjunction with page_size to paginate a list of items
number
Example
1 verbose
A boolean value that can be used to return more verbose information in a response
boolean
Example
trueResponses
Section titled “ Responses ”A list of records with contents depending on segment type
A standard error message
object
description
A human readable description of the error
string
error
A concise error message
string
type
A machine readable error type
string
Authentication error