get all
Returns a list of segments you've previously created. The segments will be returned in descending order of when they were created, unless you specify otherwise.
For custom components:
RaiselyComponents.api.all('segments').get(params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
Query parameters
Returns the full record when authenticated
Search query to find records matching
The number of records to limit per page
The pagination offset (in number of records)
The record attribute to filter on (use in conjunction with order)
The direction to sort (only applied if sort is also provided) * asc - Ascending * desc - Descending
Filter Segment based on their isShared value
Filter Segment based on their isTemporary value
Filter by organisation uuid
Filter by user uuid
Headers
A valid HTTP Bearer token, required to access private records.
Response
The resulting collection of Segment records
Example response
{
"data": [
{
"createdAt": "2020-12-03T06:52:46.330Z",
"isShared": true,
"isTemporary": true,
"label": "My Segment",
"path": "example-path",
"rules": {
"match": "all"
},
"updatedAt": "2020-12-03T06:52:46.330Z",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"pagination": {
"total": 10,
"pages": 2,
"offset": 5,
"limit": 5
}
}