UserFields REST API endpoint
Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.
Use the RestApi utility of the Public API for server-side access of this endpoint.
UserFields
Get user fields.
Applicable to: sv:userIdentity.
GET
Returns an array of objects containing information about user fields for a sv:userIdentity.
Requires the feature "social collaboration" and that social collaboration is enabled on the sv:site.
Requires that the caller is authorized to READ on sv:site.
| Name | Type | Default | Values | Description |
|---|---|---|---|---|
| list | string |
ALL | SMALL, LARGE, ALL | Filters user fields according to user field list settings on the sv:site. If omitted returns all user fields. |
| types | array |
TEXT, TEXT_FIELD, NUMBER, URL, EMAIL, TEL | Filters on type of user fields, if omitted returns user fields of all types. |
Example URL
400.3b12ee3f13dab89ecc4182/userfields
Example input
{
"list": "LARGE"
}
Example response
[
{
"id": "98.3b12ee3f13dab89ecc4182",
"identifier": "title",
"displayName": "Titel",
"type": "TEXT",
"writable": true,
"value": "Kejsare"
},
{
"id": "98.3b12ee3f13dab89ecc4183",
"identifier": "mail",
"displayName": "E-postadress",
"type": "EMAIL",
"writable": true,
"value": "test2@sitevision.se"
},
{
"id": "98.3b12ee3f13dab89ecc4184",
"identifier": "telephoneNumber",
"displayName": "Telefon",
"type": "TEL",
"writable": true,
"value": "019-123456"
}
]
Did you find the content on this page useful?