Get User Attribute

Version 4.0.25.2 (latest)

Get information about a user attribute.

Request

GET /user_attributes/{user_attribute_id}
Datatype
Description
Request
HTTP Request
path
HTTP Path
user_attribute_id
string
Id of user attribute
query
HTTP Query
fields
string
Requested fields.

Response

200: User Attribute400: Bad Request404: Not Found429: Too Many Requests
Datatype
Description
(object)
can
object
Operations the current user is able to perform on this object
id
string
Unique Id
name
string
Name of user attribute
label
string
Human-friendly label for user attribute
type
string
Type of user attribute ("string", "number", "datetime", "yesno", "zipcode", "advanced_filter_string", "advanced_filter_number")
default_value
string
Default value for when no value is set on the user
is_system
boolean
Attribute is a system default
is_permanent
boolean
Attribute is permanent and cannot be deleted
value_is_hidden
boolean
If true, users will not be able to view values of this attribute
user_can_view
boolean
Non-admin users can see the values of their attributes and use them in filters
user_can_edit
boolean
Users can change the value of this attribute for themselves
hidden_value_domain_whitelist
string
Destinations to which a hidden attribute may be sent. Once set, cannot be edited.
Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link
Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link
Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

Examples