# Index **@venuecms/sdk-next** *** ## @venuecms/sdk-next ### Configuration | Function | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [setConfig](/developers/sdk-next/reference/functions/setconfig.md) | Allows you to pass in the siteKey and API key manually in case you want it to be dynamically set. If you don't use this function, the SDK will default to using process.env.VENUE\_SITE\_KEY and process.env.VENUE\_API\_KEY instead. | ### Sites | Function | Description | | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | | [getSite](/developers/sdk-next/reference/functions/getsite.md) | Get the site configured via the siteKey (cached) | | [getSiteKeyByDomain](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/functions/getSiteKeyByDomain.md) | Get the siteKey and site id from a domain name. | | [listSiteDomains](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/functions/listSiteDomains.md) | - | | [searchSite](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/functions/searchSite.md) | Search a site for all content types (cached) | ### Events | Function | Description | | ------------------------------------------------------------------ | ----------------------------------------- | | [getEvent](/developers/sdk-next/reference/functions/getevent.md) | Retrieve data for a single event (cached) | | [getEvents](/developers/sdk-next/reference/functions/getevents.md) | Get a list of events (cached) | ### Pages | Function | Description | | ---------------------------------------------------------------- | ----------------------------------------- | | [getPage](/developers/sdk-next/reference/functions/getpage.md) | Get a single page using the slug (cached) | | [getPages](/developers/sdk-next/reference/functions/getpages.md) | Get a list of all pages (cached) | ### Profiles | Function | Description | | -------------------------------------------------------------------------------- | ---------------------------------------------- | | [getProfile](/developers/sdk-next/reference/functions/getprofile.md) | Get a profile (cached) | | [getProfileEvents](/developers/sdk-next/reference/functions/getprofileevents.md) | Get a listing of events for a profile (cached) | | [getProfiles](/developers/sdk-next/reference/functions/getprofiles.md) | Get a list of profiles (cached) | ### Products | Function | Description | | ---------------------------------------------------------------------- | ---------------------------------- | | [getProduct](/developers/sdk-next/reference/functions/getproduct.md) | Get a product (cached) | | [getProducts](/developers/sdk-next/reference/functions/getproducts.md) | Get a listing of products (cached) | ### Utilities | Function | Description | | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [getLocalizedContent](/developers/sdk-next/reference/functions/getlocalizedcontent.md) | This function will properly resolve content blocks that are localized. It takes in the array of localized content and returns the proper content to be used in your page. | ### Other | Name | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | [NodeHandlers](/developers/sdk-next/reference/interfaces/nodehandlers.md) | - | | [NodeProps](/developers/sdk-next/reference/interfaces/nodeprops.md) | - | | [RenderNode](/developers/sdk-next/reference/interfaces/rendernode.md) | - | | [AddCustomDomainData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/AddCustomDomainData.md) | - | | [AddCustomDomainError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/AddCustomDomainError.md) | - | | [AddCustomDomainResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/AddCustomDomainResponse.md) | - | | [AddDomainInput](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/AddDomainInput.md) | - | | [AddDomainResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/AddDomainResponse.md) | - | | [BatchEmail](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/BatchEmail.md) | - | | [BatchPagination](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/BatchPagination.md) | - | | [BatchSendResult](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/BatchSendResult.md) | - | | [ContentStyles](/developers/sdk-next/reference/type-aliases/contentstyles.md) | - | | [CreateAndSendBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/CreateAndSendBatchData.md) | - | | [CreateAndSendBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/CreateAndSendBatchError.md) | - | | [CreateAndSendBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/CreateAndSendBatchResponse.md) | - | | [CreateDraftBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/CreateDraftBatchData.md) | - | | [CreateDraftBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/CreateDraftBatchError.md) | - | | [CreateDraftBatchInput](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/CreateDraftBatchInput.md) | - | | [CreateDraftBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/CreateDraftBatchResponse.md) | - | | [CustomSchemaData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/CustomSchemaData.md) | - | | [DeleteBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/DeleteBatchData.md) | - | | [DeleteBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/DeleteBatchError.md) | - | | [DeleteBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/DeleteBatchResponse.md) | - | | [DnsRecord](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/DnsRecord.md) | - | | [DomainStatus](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/DomainStatus.md) | - | | [DraftBatchResult](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/DraftBatchResult.md) | - | | [Email](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/Email.md) | - | | [EmailBatch](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/EmailBatch.md) | - | | [EmailBatchDetail](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/EmailBatchDetail.md) | - | | [EmailBatchesResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/EmailBatchesResponse.md) | - | | [EmailConfig](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/EmailConfig.md) | - | | [EmailConfigInput](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/EmailConfigInput.md) | - | | [EmailsResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/EmailsResponse.md) | - | | [EmailStats](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/EmailStats.md) | - | | [Event](/developers/sdk-next/reference/type-aliases/event.md) | - | | [GetDomainStatusData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetDomainStatusData.md) | - | | [GetDomainStatusError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetDomainStatusError.md) | - | | [GetDomainStatusResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetDomainStatusResponse.md) | - | | [GetEmailBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailBatchData.md) | - | | [GetEmailBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailBatchError.md) | - | | [GetEmailBatchesData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailBatchesData.md) | - | | [GetEmailBatchesError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailBatchesError.md) | - | | [GetEmailBatchesResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailBatchesResponse.md) | - | | [GetEmailBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailBatchResponse.md) | - | | [GetEmailByIdData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailByIdData.md) | - | | [GetEmailByIdError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailByIdError.md) | - | | [GetEmailByIdResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailByIdResponse.md) | - | | [GetEmailConfigData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailConfigData.md) | - | | [GetEmailConfigError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailConfigError.md) | - | | [GetEmailConfigResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailConfigResponse.md) | - | | [GetEmailsData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailsData.md) | - | | [GetEmailsError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailsError.md) | - | | [GetEmailsResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailsResponse.md) | - | | [GetEmailStatsData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailStatsData.md) | - | | [GetEmailStatsError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailStatsError.md) | - | | [GetEmailStatsResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetEmailStatsResponse.md) | - | | [GetEventData](/developers/sdk-next/reference/type-aliases/geteventdata.md) | - | | [GetEventError](/developers/sdk-next/reference/type-aliases/geteventerror.md) | - | | [GetEventResponse](/developers/sdk-next/reference/type-aliases/geteventresponse.md) | - | | [GetEventsData](/developers/sdk-next/reference/type-aliases/geteventsdata.md) | - | | [GetEventsError](/developers/sdk-next/reference/type-aliases/geteventserror.md) | - | | [GetEventsResponse](/developers/sdk-next/reference/type-aliases/geteventsresponse.md) | - | | [GetPageData](/developers/sdk-next/reference/type-aliases/getpagedata.md) | - | | [GetPageError](/developers/sdk-next/reference/type-aliases/getpageerror.md) | - | | [GetPageResponse](/developers/sdk-next/reference/type-aliases/getpageresponse.md) | - | | [GetPagesData](/developers/sdk-next/reference/type-aliases/getpagesdata.md) | - | | [GetPagesError](/developers/sdk-next/reference/type-aliases/getpageserror.md) | - | | [GetPagesResponse](/developers/sdk-next/reference/type-aliases/getpagesresponse.md) | - | | [GetProductData](/developers/sdk-next/reference/type-aliases/getproductdata.md) | - | | [GetProductError](/developers/sdk-next/reference/type-aliases/getproducterror.md) | - | | [GetProductResponse](/developers/sdk-next/reference/type-aliases/getproductresponse.md) | - | | [GetProductsData](/developers/sdk-next/reference/type-aliases/getproductsdata.md) | - | | [GetProductsError](/developers/sdk-next/reference/type-aliases/getproductserror.md) | - | | [GetProductsResponse](/developers/sdk-next/reference/type-aliases/getproductsresponse.md) | - | | [GetProfileData](/developers/sdk-next/reference/type-aliases/getprofiledata.md) | - | | [GetProfileError](/developers/sdk-next/reference/type-aliases/getprofileerror.md) | - | | [GetProfileEventsData](/developers/sdk-next/reference/type-aliases/getprofileeventsdata.md) | - | | [GetProfileEventsError](/developers/sdk-next/reference/type-aliases/getprofileeventserror.md) | - | | [GetProfileEventsResponse](/developers/sdk-next/reference/type-aliases/getprofileeventsresponse.md) | - | | [GetProfileResponse](/developers/sdk-next/reference/type-aliases/getprofileresponse.md) | - | | [GetProfilesData](/developers/sdk-next/reference/type-aliases/getprofilesdata.md) | - | | [GetProfilesError](/developers/sdk-next/reference/type-aliases/getprofileserror.md) | - | | [GetProfilesResponse](/developers/sdk-next/reference/type-aliases/getprofilesresponse.md) | - | | [GetSiteByDomainData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetSiteByDomainData.md) | - | | [GetSiteByDomainError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetSiteByDomainError.md) | - | | [GetSiteByDomainResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/GetSiteByDomainResponse.md) | - | | [GetSiteData](/developers/sdk-next/reference/type-aliases/getsitedata.md) | - | | [GetSiteError](/developers/sdk-next/reference/type-aliases/getsiteerror.md) | - | | [GetSiteResponse](/developers/sdk-next/reference/type-aliases/getsiteresponse.md) | - | | [ListSiteDomainsData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/ListSiteDomainsData.md) | - | | [ListSiteDomainsError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/ListSiteDomainsError.md) | - | | [ListSiteDomainsResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/ListSiteDomainsResponse.md) | - | | [LocalizedContent](/developers/sdk-next/reference/type-aliases/localizedcontent.md) | - | | [Location](/developers/sdk-next/reference/type-aliases/location.md) | - | | [MediaItem](/developers/sdk-next/reference/type-aliases/mediaitem.md) | - | | [NodeHandler](/developers/sdk-next/reference/type-aliases/nodehandler.md) | - | | [Page](/developers/sdk-next/reference/type-aliases/page.md) | - | | [Pagination](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/Pagination.md) | - | | [Product](/developers/sdk-next/reference/type-aliases/product.md) | - | | [ProductVariant](/developers/sdk-next/reference/type-aliases/productvariant.md) | - | | [Profile](/developers/sdk-next/reference/type-aliases/profile.md) | - | | [publishState](/developers/sdk-next/reference/type-aliases/publishstate.md) | - | | [Recipient](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/Recipient.md) | - | | [recordType](/developers/sdk-next/reference/type-aliases/recordtype.md) | - | | [RemoveCustomDomainData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/RemoveCustomDomainData.md) | - | | [RemoveCustomDomainError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/RemoveCustomDomainError.md) | - | | [RemoveCustomDomainResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/RemoveCustomDomainResponse.md) | - | | [SearchSiteData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/SearchSiteData.md) | - | | [SearchSiteError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/SearchSiteError.md) | - | | [SearchSiteResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/SearchSiteResponse.md) | - | | [SearchSiteResults](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/SearchSiteResults.md) | - | | [SendBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/SendBatchData.md) | - | | [SendBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/SendBatchError.md) | - | | [SendBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/SendBatchResponse.md) | - | | [Site](/developers/sdk-next/reference/type-aliases/site.md) | - | | [SiteSettings](/developers/sdk-next/reference/type-aliases/sitesettings.md) | - | | [status](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/status.md) | - | | [status2](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/status2.md) | - | | [status3](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/status3.md) | - | | [status4](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/status4.md) | - | | [Tag](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/Tag.md) | - | | [TicketOnEvent](/developers/sdk-next/reference/type-aliases/ticketonevent.md) | - | | [UpdateDraftBatchData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/UpdateDraftBatchData.md) | - | | [UpdateDraftBatchError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/UpdateDraftBatchError.md) | - | | [UpdateDraftBatchInput](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/UpdateDraftBatchInput.md) | - | | [UpdateDraftBatchResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/UpdateDraftBatchResponse.md) | - | | [UpdateEmailConfigData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/UpdateEmailConfigData.md) | - | | [UpdateEmailConfigError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/UpdateEmailConfigError.md) | - | | [UpdateEmailConfigResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/UpdateEmailConfigResponse.md) | - | | [VerifyDomainData](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/VerifyDomainData.md) | - | | [VerifyDomainError](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/VerifyDomainError.md) | - | | [VerifyDomainResponse](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/VerifyDomainResponse.md) | - | | [WebSite](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/type-aliases/WebSite.md) | - | | [cache](https://github.com/venuecms/sdk/blob/main/packages/docs/sdk-next/reference/functions/cache.md) | - | | [VenueContent](/developers/sdk-next/reference/functions/venuecontent.md) | - | | [VenueImage](/developers/sdk-next/reference/functions/venueimage.md) | - | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.venuecms.com/developers/sdk-next/reference/index.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.