> 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 # ListExtendedFields # Package: contacts # Namespace: ContactExtendedFieldsServiceV4 # Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/extended-fields/list-extended-fields.md ## Permission Scopes: Manage Contact Extended Fields: SCOPE.DC-CONTACTS.MANAGE-EX-FIELDS ## Introduction Retrieves a list of extended fields. --- ## REST API ### Schema ``` Method: listExtendedFields Description: Retrieves a list of extended fields. URL: https://www.wixapis.com/contacts/v4/extended-fields Method: GET Method parameters: param name: fieldType | type: FieldType - enum: SYSTEM - Field is a system field managed by Wix. System fields can't be modified by calling the Update Extended Field method. USER_DEFINED - Field is a custom field and can be modified by calling the Update Extended Field method. query param name: namespace | type: namespace | description: Filter for fields in the specified namespace. Fields created by calling the Find Or Create Extended Field method are automatically assigned to the `custom` namespace. param name: paging | type: Paging - name: limit | type: integer | description: Number of items to return. Defaults to `100`. - name: offset | type: integer | description: Number of items to skip in the current sort order. Defaults to `0`. param name: sort | type: Sorting - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. Default: `ASC`. - enum: - ASC: Sort by ascending order. - DESC: Sort by descending order. query param name: startsWith | type: startsWith | description: Filter for fields where `displayName` starts with the specified case-sensitive string. Return type: ListExtendedFieldsResponse - name: fields | type: array | description: List of extended fields. - name: namespace | type: string | description: Extended field namespace. Extended fields created through by calling the Find Or Create Extended Field method are automatically assigned to the `custom` namespace. - name: key | type: string | description: Extended field key. When accessing contact data, extended field data is available at `extendedFields[key]`. For example, if the key is "custom.notes", the value can be accessed at `extendedFields["custom.notes"]`. `key` is generated when the extended field is created and can't be modified, even if `displayName` changes. - name: displayName | type: string | description: Display name shown in the contact list. - name: dataType | type: FieldDataType | description: Type of data the field holds. - enum: - TEXT: Accepts strings. - NUMBER: Accepts floats. - DATE: Accepts dates formatted as `YYYY-MM-DD`. - URL: Accepts strings. Prepends `https://` if no protocol is included. - name: fieldType | type: FieldType | description: Indicates whether the extended field is a system field or custom field. - enum: - SYSTEM: Field is a system field managed by Wix. System fields can't be modified by calling the Update Extended Field method. - USER_DEFINED: Field is a custom field and can be modified by calling the Update Extended Field method. - name: createdDate | type: string | description: Date and time the field was created. - name: updatedDate | type: string | description: Date and time the field was last updated. - name: description | type: string | description: Field description, if the field is a system field. - name: metadata | type: PagingMetadata | description: Metadata for the page of results. - name: count | type: integer | description: Number of items returned. - name: offset | type: integer | description: Requested offset. - name: total | type: integer | description: Number of items that matched the query. - name: tooManyToCount | type: boolean | description: Indicates if `total` calculation timed out before the response was sent. Typically this happens if there is a large set of results. ``` ### Examples ### List Extended Fields ```curl curl -X GET \ 'https://www.wixapis.com/contacts/v4/extended-fields' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.contacts.ContactExtendedFieldsServiceV4.listExtendedFields(options) Description: Retrieves a list of extended fields. Method parameters: param name: options | type: ListExtendedFieldsOptions none - name: fieldType | type: FieldType | description: Filter for fields of the specified type. - enum: - SYSTEM: Field is a system field managed by Wix. System fields can't be modified by calling the Update Extended Field method. - USER_DEFINED: Field is a custom field and can be modified by calling the Update Extended Field method. - name: namespace | type: string | description: Filter for fields in the specified namespace. Fields created by calling the Find Or Create Extended Field method are automatically assigned to the `custom` namespace. - name: startsWith | type: string | description: Filter for fields where `displayName` starts with the specified case-sensitive string. - name: sort | type: Sorting | description: Sorting options. - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. Default: `ASC`. - enum: - ASC: Sort by ascending order. - DESC: Sort by descending order. - name: paging | type: Paging | description: Paging options. - name: limit | type: integer | description: Number of items to return. Defaults to `100`. - name: offset | type: integer | description: Number of items to skip in the current sort order. Defaults to `0`. Return type: PROMISE - name: fields | type: array | description: List of extended fields. - name: namespace | type: string | description: Extended field namespace. Extended fields created through by calling the Find Or Create Extended Field method are automatically assigned to the `custom` namespace. - name: key | type: string | description: Extended field key. When accessing contact data, extended field data is available at `extendedFields[key]`. For example, if the key is "custom.notes", the value can be accessed at `extendedFields["custom.notes"]`. `key` is generated when the extended field is created and can't be modified, even if `displayName` changes. - name: displayName | type: string | description: Display name shown in the contact list. - name: dataType | type: FieldDataType | description: Type of data the field holds. - enum: - TEXT: Accepts strings. - NUMBER: Accepts floats. - DATE: Accepts dates formatted as `YYYY-MM-DD`. - URL: Accepts strings. Prepends `https://` if no protocol is included. - name: fieldType | type: FieldType | description: Indicates whether the extended field is a system field or custom field. - enum: - SYSTEM: Field is a system field managed by Wix. System fields can't be modified by calling the Update Extended Field method. - USER_DEFINED: Field is a custom field and can be modified by calling the Update Extended Field method. - name: _createdDate | type: Date | description: Date and time the field was created. - name: _updatedDate | type: Date | description: Date and time the field was last updated. - name: description | type: string | description: Field description, if the field is a system field. - name: metadata | type: PagingMetadata | description: Metadata for the page of results. - name: count | type: integer | description: Number of items returned. - name: offset | type: integer | description: Requested offset. - name: total | type: integer | description: Number of items that matched the query. - name: tooManyToCount | type: boolean | description: Indicates if `total` calculation timed out before the response was sent. Typically this happens if there is a large set of results. ``` ### Examples ### listExtendedFields ```javascript import { extendedFields } from '@wix/crm'; async function listExtendedFields(options) { const response = await extendedFields.listExtendedFields(options); }; ``` ### listExtendedFields (with elevated permissions) ```javascript import { extendedFields } from '@wix/crm'; import { auth } from '@wix/essentials'; async function myListExtendedFieldsMethod(options) { const elevatedListExtendedFields = auth.elevate(extendedFields.listExtendedFields); const response = await elevatedListExtendedFields(options); } ``` ### listExtendedFields (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 { extendedFields } from '@wix/crm'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { extendedFields }, // Include the auth strategy and host as relevant }); async function listExtendedFields(options) { const response = await myWixClient.extendedFields.listExtendedFields(options); }; ``` ---