> 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 # GetDataItem # Package: cms # Namespace: DataItemService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/cms/data-items/get-data-item.md ## Permission Scopes: Read Data Items: SCOPE.DC-DATA.READ ## Introduction Retrieves an item from a collection. --- ## REST API ### Schema ``` Method: getDataItem Description: Retrieves an item from a collection. URL: https://www.wixapis.com/wix-data/v2/items/{dataItemId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: dataItemId, dataCollectionId Method parameters: query param name: appOptions | type: appOptions | description: Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying. When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields.md), pass the following optional parameters: - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`. - `includeVariants`: Whether to include product variants in the query. Default: `false`. query param name: consistentRead | type: consistentRead | description: Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up to date even immediately after an update. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency). Default: `false` query param name: dataCollectionId | type: dataCollectionId | description: GUID of the collection from which to retrieve the data item. | required: true param name: dataItemId | type: none | required: true query param name: fields | type: array | description: Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned. **Note:** The `_id` system field is always returned. query param name: includeFieldGroups | type: array | description: Requests conditional fields. Currently used in App Collections. Please refer to app collection documentation for a list of valid values. query param name: includeReferences | type: array | description: Fields for which to include referenced items. For each reference field specified, the response includes the full data items being referenced. Use this to retrieve related data in a single call without additional queries. - name: field | type: string | description: Field containing references in the item. This field must be configured as a reference or multi-reference field in the collection schema. - name: limit | type: integer | description: Maximum number of referenced items to include for each item. When a reference field contains more items than this limit, only the first items up to the limit are included in the response. If not specified, up to 50 items are included. query param name: language | type: language | description: Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. If provided, the result text is returned in the specified language. **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual). If not provided, result text is not translated. param name: publishPluginOptions | type: PublishPluginOptions - name: includeDraftItems | type: boolean | description: Whether to include draft items. When `true`, both published and draft items are affected. Default: `false`. query param name: referencedItemOptions | type: array | description: Options for retrieving referenced items. - name: fieldName | type: string | description: Field containing references in the queried item. - name: limit | type: integer | description: Maximum number of referenced items to include for each queried item. Return type: GetDataItemResponse - name: dataItem | type: DataItem | description: Retrieved item. - name: id | type: string | description: Data item GUID. - name: dataCollectionId | type: string | description: GUID of the collection this item belongs to - name: data | type: object | description: Data item contents. Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields: + `_id`: Item GUID. + `_createdDate`: Date and time the item was added to the collection. + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value. + `_ownerId`: GUID of the user who created the item. Can be modified with site owner permissions. ``` ### Examples ### Get existing item ```curl curl -X GET \ 'https://www.wixapis.com/wix-data/v2/items/5331fc15-9441-4fd4-bc7b-7f6870c69228?dataCollectionId=cities' \ -H 'Authorization: ' \ ``` ### Get existing item with complex id and consistent read ```curl curl -X POST \ 'https://www.wixapis.com/wix-data/v2/items/get' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' \ -d '{ "dataCollectionId": "cities", "dataItemId": "%id1", "consistentRead": true }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.cms.DataItemService.getDataItem(dataCollectionId, itemId, options) Description: Retrieves an item from a collection. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: dataCollectionId, itemId Method parameters: param name: dataCollectionId | type: string | description: GUID of the collection from which to retrieve the data item. | required: true param name: itemId | type: string | description: GUID of the data item to retrieve. | required: true param name: options | type: WixDataReadWithProjectionOptions none - name: consistentRead | type: boolean | description: Whether to retrieve data from the primary database instance. This decreases performance but ensures data retrieved is up to date even immediately after an update. Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency). Default: `false` - name: language | type: string | description: Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. If provided, the result text is returned in the specified language. **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual). If not provided, result text is not translated. - name: fields | type: array | description: Fields to return for the item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned. **Note:** The `_id` system field is always returned. - name: suppressHooks | type: boolean | description: Whether to suppress data hooks. When `true`, data hooks typically triggered by this endpoint don't run. **Note:** This option can only be used in code that runs in [the Wix site backend](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/backend-code/about-the-site-backend.md). Default: `false` - name: appOptions | type: object | description: Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying. When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields.md), pass the following optional parameters: - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`. - `includeVariants`: Whether to include product variants in the query. Default: `false`. - name: includeFieldGroups | type: array | description: Requests conditional fields. Currently used in App Collections. Please refer to app collection documentation for a list of valid values. - name: includeReferences | type: array | description: Fields for which to include referenced items. For each reference field specified, the response includes the full data items being referenced. Use this to retrieve related data in a single call without additional queries. - name: field | type: string | description: Field containing references in the item. This field must be configured as a reference or multi-reference field in the collection schema. - name: limit | type: integer | description: Maximum number of referenced items to include for each item. When a reference field contains more items than this limit, only the first items up to the limit are included in the response. If not specified, up to 50 items are included. - name: showDrafts | type: boolean | description: When `true`, operations include draft items. Read operations include draft items in their response, and write operations modify draft items. Return type: PROMISE - name: _id | type: string | description: Data item GUID. - name: _createdDate | type: Date | description: Date and time the item was added to the collection. - name: _updatedDate | type: Date | description: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value. - name: _owner | type: string | description: GUID of the user who created the item. Can be modified with site owner permissions. ``` ### Examples ### get ```javascript import { items } from '@wix/data'; async function get(dataCollectionId,itemId,options) { const response = await items.get(dataCollectionId,itemId,options); }; ``` ### get (with elevated permissions) ```javascript import { items } from '@wix/data'; import { auth } from '@wix/essentials'; async function myGetMethod(dataCollectionId,itemId,options) { const elevatedGet = auth.elevate(items.get); const response = await elevatedGet(dataCollectionId,itemId,options); } ``` ### get (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 { items } from '@wix/data'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { items }, // Include the auth strategy and host as relevant }); async function get(dataCollectionId,itemId,options) { const response = await myWixClient.items.get(dataCollectionId,itemId,options); }; ``` ---