> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetCustomFieldApplication # Package: customFields # Namespace: CustomFieldApplications # Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/members/member-management/custom-fields/custom-field-applications/get-custom-field-application.md ## Permission Scopes: Read Members: SCOPE.DC-MEMBERS.READ-MEMBERS ## Introduction Retrieves a custom field application. --- ## REST API ### Schema ``` Method: getCustomFieldApplication Description: Retrieves a custom field application. URL: https://www.wixapis.com/members/v1/custom-fields-applications/{customFieldId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: customFieldId Method parameters: param name: customFieldId | type: none | required: true Return type: GetCustomFieldApplicationResponse - name: application | type: CustomFieldApplication | description: Retrieved custom field application. - name: customFieldId | type: string | description: Custom field GUID. - name: customFieldKey | type: string | description: Custom field key. - name: applications | type: ApplicationsWrapper | description: Entities to which the custom field applies. - name: items | type: array | description: List of up to 100 entities to which the the custom field applies. - name: applicationType | type: Type | description: Type of the application. - enum: - UNKNOWN: Unknown application type. This value isn't used. - ROLE: The field is applied to members with a specific role. - BADGE: The field is applied to members with a specific badge. - PRICING_PLAN: The field is applied to members with a specific pricing plan. - MEMBER: The field is applied to the specified members. - name: entityId | type: string | description: Entity GUID. - name: exclusions | type: ExclusionsWrapper | description: Entities from which the custom field is excluded. - name: items | type: array | description: List of up to 100 entities from which the custom field is excluded. - name: exclusionType | type: Type | description: Type of the exclusion. - enum: - UNKNOWN: Unknown exclusion type. This value isn't used. - ROLE: The field is excluded from members with a specific role. - BADGE: The field is excluded from members with a specific badge. - PRICING_PLAN: The field is excluded from members with a specific pricing plan. - MEMBER: The field is excluded from the specified members. - name: entityId | type: string | description: Entity GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the custom field is updated. To prevent conflicting changes, the existing revision must be used when updating a custom field. ``` ### Examples ### Get a custom field application ```curl curl -X GET \ https://www.wixapis.com/members/v1/members/custom-fields-applications/4e4b1840-3833-4dbd-93d1-b2c9a33caa7d \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.customFields.CustomFieldApplications.getCustomFieldApplication(customFieldId) Description: Retrieves a custom field application. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: customFieldId Method parameters: param name: customFieldId | type: string | description: GUID of the custom field with an application to retrieve. | required: true Return type: PROMISE - name: application | type: CustomFieldApplication | description: Retrieved custom field application. - name: customFieldId | type: string | description: Custom field GUID. - name: customFieldKey | type: string | description: Custom field key. - name: applications | type: ApplicationsWrapper | description: Entities to which the custom field applies. - name: items | type: array | description: List of up to 100 entities to which the the custom field applies. - name: applicationType | type: Type | description: Type of the application. - enum: - UNKNOWN: Unknown application type. This value isn't used. - ROLE: The field is applied to members with a specific role. - BADGE: The field is applied to members with a specific badge. - PRICING_PLAN: The field is applied to members with a specific pricing plan. - MEMBER: The field is applied to the specified members. - name: entityId | type: string | description: Entity GUID. - name: exclusions | type: ExclusionsWrapper | description: Entities from which the custom field is excluded. - name: items | type: array | description: List of up to 100 entities from which the custom field is excluded. - name: exclusionType | type: Type | description: Type of the exclusion. - enum: - UNKNOWN: Unknown exclusion type. This value isn't used. - ROLE: The field is excluded from members with a specific role. - BADGE: The field is excluded from members with a specific badge. - PRICING_PLAN: The field is excluded from members with a specific pricing plan. - MEMBER: The field is excluded from the specified members. - name: entityId | type: string | description: Entity GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the custom field is updated. To prevent conflicting changes, the existing revision must be used when updating a custom field. ``` ### Examples ### getCustomFieldApplication ```javascript import { customFieldApplications } from '@wix/members'; async function getCustomFieldApplication(customFieldId) { const response = await customFieldApplications.getCustomFieldApplication(customFieldId); }; ``` ### getCustomFieldApplication (with elevated permissions) ```javascript import { customFieldApplications } from '@wix/members'; import { auth } from '@wix/essentials'; async function myGetCustomFieldApplicationMethod(customFieldId) { const elevatedGetCustomFieldApplication = auth.elevate(customFieldApplications.getCustomFieldApplication); const response = await elevatedGetCustomFieldApplication(customFieldId); } ``` ### getCustomFieldApplication (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { customFieldApplications } from '@wix/members'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { customFieldApplications }, // Include the auth strategy and host as relevant }); async function getCustomFieldApplication(customFieldId) { const response = await myWixClient.customFieldApplications.getCustomFieldApplication(customFieldId); }; ``` ---