POST

Get Roles Custom Field Applications


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of fields that are applied to specified roles.

Endpoint
POST
https://www.wixapis.com/members/v1/custom-fields-applications/roles

Body Params
roleIdsArray <string>Requiredformat GUIDminItems 1maxItems 100

IDs of roles which custom field applications to retrieve.

Response Object
resultsArray <RoleCustomFieldApplication>

List of custom field applications.

Get roles custom field applications
Request
cURL
curl -X POST \ https://www.wixapis.com/members/v1/members/custom-fields-applications/roles \ -H 'Content-Type: application/json;charset=UTF-8' \ -H 'Authorization: <AUTH>' -d '{ "roleIds": [ "a7c33e4e-d769-4954-ab87-b3d0492703b4" ] }'
Response
JSON
{ "results": [ { "roleId": "a7c33e4e-d769-4954-ab87-b3d0492703b4", "applications": [ { "customFieldKey": "custom.astrological-sign", "applies": true, "customField": { "id": "4e4b1840-3833-4dbd-93d1-b2c9a33caa7d", "name": "Astrological Sign", "key": "custom.astrological-sign", "defaultPrivacy": "PRIVATE", "fieldType": "TEXT", "socialType": "UNKNOWN", "fieldOrigin": "CUSTOM", "appliesTo": "SELECTED_MEMBERS", "section": "GENERAL", "createdDate": "2024-01-01T01:01:01.1Z", "updatedDate": "2024-03-04T01:01:01.1Z", "revision": "10" } }, { "customFieldKey": "customfields.system.firstname", "applies": true, "customField": { "id": "b0a387ef-0bbe-424f-ad18-1960b285dbb2", "name": "First Name", "key": "customfields.system.firstname", "defaultPrivacy": "PRIVATE", "fieldType": "TEXT", "socialType": "OTHER", "fieldOrigin": "SYSTEM", "appliesTo": "ALL_MEMBERS", "section": "GENERAL", "createdDate": "2024-01-01T01:01:01.1Z", "updatedDate": "2024-03-04T01:01:01.1Z", "revision": "6" } } ] } ] }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?