Segments - Find a segment by name
GET /segments/v2/{bucket}/find
A list of all the active segments in the system matching the search term.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The bucket (client) name
Example
exampleQuery Parameters
Section titled “Query Parameters ”The number of items to return per page, usually used in conjunction with page to paginate a list of items
Example
10A page number, usually used in conjunction with page_size to paginate a list of items
Example
1Responses
Section titled “ Responses ”The segments
object
object
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
Example
2023-09-05T11:27:06.437000The human readable value of the record the URI points to
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
Example
2023-09-05T11:27:06.437000The type of resource, usually the second element in the URI e.g person, organisation, member, payment
Example
personobject
Dynamic segments are based on a query that is run each time the segment is accessed. Static segments are lists of records. Hybrid segments are a combination of dynamic and static segments. They can support a rule with exclusions or inclusions. Auxiliary segments are nodes with no data of their own. They are used to group segments into a navigable hierarchy.
System segments are created by the system and cannot be edited or deleted.
Usually the final element in the URI, an alphanumeric unique identifier
Example
6305f074683e800f3abe809eURIs are unique identifiers for resources in the system,
they are structured as follows /bucket/resource_type/uid/
Example
/example/person/6305f074683e800f3abe809e/object
A standard error message
object
A human readable description of the error
A concise error message
A machine readable error type
Authentication error