Segment - Config
GET /segments/v2/{bucket}/segment/{uid}/config
GET
/segments/v2/{bucket}/segment/{uid}/config
The config for a segment
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” bucket
required
The bucket (client) name
string
Example
example resource_type
required
The type of resource, usually the second element in the URI e.g person, organisation, member, payment
string
Example
person uid
required
Usually the final element in the URI, an alphanumeric unique identifier
string
Example
6305f074683e800f3abe809eResponses
Section titled “ Responses ”The segment configuration
object
mapping
object
collection
string
contact_field
contact_search_fields
Array
field_list
Array<string>
fields
Array<object>
object
field
string
form_type
string
label
string
style
string
join_orgs
boolean
join_people
boolean
name
string
name_singular
string
prefix
string
search_fields
Array<string>
search_placeholder
string
sort_by
Array<string>
unique_field
string
use_mapreduce
boolean
resource_type
string
segment
URIs are unique identifiers for resources in the system,
they are structured as follows /bucket/resource_type/uid/
string
Example
/example/person/6305f074683e800f3abe809e/ segment_type
string
user_groups
Array
user_groups_for_display
Array
user_interface
object
can_bypass_gdpr
Array<boolean>
can_create_segment
boolean
can_delete_segment
boolean
can_edit_segment
boolean
can_restore_segment
boolean
view_context
Array<string>
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