> 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 # GetDynamicContext # Package: dynamicSiteContext # Namespace: DynamicContextService # Method link: https://dev.wix.com/docs/api-reference/tools/dynamic-site-context/get-dynamic-context.md ## Introduction Retrieves aggregated context for the caller's sites and account. Returns enriched site information including installed apps, editor type, Velo status, and account details. Results are paginated using cursor-based paging. You can optionally filter by a single site ID or site display name. When no filter is provided, all of the caller's sites are returned. --- ## REST API ### Schema ``` Method: getDynamicContext Description: Retrieves aggregated context for the caller's sites and account. Returns enriched site information including installed apps, editor type, Velo status, and account details. Results are paginated using cursor-based paging. You can optionally filter by a single site GUID or site display name. When no filter is provided, all of the caller's sites are returned. URL: https://www.wixapis.com/_api/dynamic-context/v1/dynamic-context Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. | validation: minimum 0, maximum 100, format int32 - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. | validation: maxLength 16000 - name: filter | type: object | description: Filter object. Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-filter-section). - name: sort | type: array | description: Sort object. Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#the-sort-section). | validation: maxItems 5 - name: fieldName | type: string | description: Name of the field to sort by. | validation: maxLength 512 - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC - ONE-OF: - name: siteId | type: string | description: Filter results to a single site by its GUID (GUGUID format). When provided, the response contains at most one site. | validation: maxLength 36, format GUID - name: siteName | type: string | description: Filter results to a single site by its display name (exact match). When provided, the response contains at most one site. | validation: maxLength 500 Return type: GetDynamicContextResponse - name: account | type: Account | description: Account-level information for the calling user. - name: id | type: string | description: Unique account identifier. | validation: maxLength 36, format GUID - name: createdDate | type: string | description: Date and time the account was created. | validation: format date-time - name: updatedDate | type: string | description: Date and time the account was last modified. | validation: format date-time - name: displayName | type: string | description: The account holder's display name. This field contains PII. | validation: maxLength 500 - name: status | type: AccountStatus | description: Current status of the account. - enum: - ACCOUNT_STATUS_UNSPECIFIED: Default value. Not used. - ACTIVE: The account is active and in good standing. - BLOCKED: The account has been blocked by Wix. - DELETED: The account has been deleted. - name: coBranding | type: string | description: Co-branding partner label, if the account was created through a partner program. | validation: maxLength 50 - name: sites | type: array | description: Enriched context for each matching site, including installed apps and editor metadata. Results are ordered by site creation date and limited to the requested page size. | validation: maxItems 100 - name: id | type: string | description: Unique site identifier. | validation: maxLength 36, format GUID - name: displayName | type: string | description: Human-readable site name as shown in the dashboard. | validation: maxLength 500 - name: url | type: string | description: Published site URL. Only present for published sites with a live URL. | validation: maxLength 2048 - name: createdDate | type: string | description: Date and time the site was created. | validation: format date-time - name: updatedDate | type: string | description: Date and time the site was last modified. | validation: format date-time - name: published | type: boolean | description: Whether the site is currently published and accessible to visitors. - name: premium | type: boolean | description: Whether the site has an active Wix Premium plan. - name: ownerAccountId | type: string | description: Account GUID of the site owner. | validation: format GUID - name: editorType | type: EditorType | description: The editor type used to build and manage this site (e.g., `WIX`, `STUDIO`, `EDITOR_X`). - enum: - EDITOR_TYPE_UNSPECIFIED: - WIX: Classic Editor. - STUDIO: Studio Editor. - EDITOR_X: EditorX. - EDITOR_3: Editor3. - WIX_VIBE: Wix Vibe. - BLOCKS: Blocks Editor. - MOBILE_WIDGET_BUILDER: Mobile Widget Builder. - EDITOR: Classic Editor (legacy alias). - STUDIO_TWO: Studio 2. - ADI: ADI (Artificial Design Intelligence). - WIXEL: Wixel Editor. - PICASSO: Picasso Editor. - EDITORLESS: Editorless (no editor site). - ODEDITOR: OD Editor. - UNKNOWN: Unknown (source default). - name: namespace | type: SiteNamespace | description: The origin or creation source of this site (e.g., `WIX`, `HEADLESS`, `RISE`). - enum: - SITE_NAMESPACE_UNSPECIFIED: - WIX: Standard Wix Editor site. - SHOUT_OUT: Wix ShoutOut email marketing. - ALBUMS: Wix Photo Albums. - WIX_STORES_TEST_DRIVES: Wix Stores test-drive sites. - WIX_STORES_TEST_DRIVE: Wix Stores test-drive (singular alias). - UNKNOWN_NAMESPACE: Unknown namespace (default source value). - HOTELS: Wix Hotels vertical. - CLUBS: Wix Clubs (community groups). - ONBOARDING_DRAFT: Onboarding draft site (created during signup flow). - DEV_SITE: Developer / sandbox site. - LOGOS: Wix Logo Maker. - VIDEO_MAKER: Wix Video Maker. - PARTNER_DASHBOARD: Wix Partner Dashboard site. - DEV_CENTER_COMPANY: Wix Dev Center company site. - HTML_DRAFT: HTML-based draft site. - SITELESS_BUSINESS: Business entity without a published site. - CREATOR_ECONOMY: Creator Economy platform. - DASHBOARD_FIRST: Dashboard-first experience (site created from dashboard). - ANYWHERE: Wix Anywhere (mobile-first creation). - HEADLESS: Headless / API-only site (no visual editor). - ACCOUNT_MASTER_CMS: Account-level master CMS. - RISE: Wix Rise platform. - BRANDED_FIRST: Branded-first creation flow. - NOWNIA: Nownia AI site builder. - UGC_TEMPLATE: User-generated content template. - CODUX: Codux visual IDE. - MEDIA_DESIGN_CREATOR: Media / design creator tool. - SHARED_BLOG_ENTERPRISE: Shared blog for enterprise accounts. - STANDALONE_FORMS: Standalone Forms app site. - STANDALONE_EVENTS: Standalone Events app site. - MIMIR: Mimir platform. - TWINS: Twins platform. - NANO: Nano lightweight site. - BASE44: Base44 platform. - CHANNELS: Channels platform. - name: domainConnected | type: boolean | description: Whether a custom domain (non-Wix) is connected to this site. - name: installedApps | type: array | description: List of apps currently installed and enabled on this site. | validation: maxItems 500 - name: appId | type: string | description: The app's definition GUID (unique identifier for the app). | validation: maxLength 36, format GUID - name: catalogVersion | type: string | description: The Wix Stores catalog version. Either `"V1"` or `"V3"`. Only present when the app is Wix Stores; absent for all other apps. | validation: maxLength 20 - name: veloEnabled | type: boolean | description: Whether Velo by Wix (Wix Code) is enabled on this site. - name: properties | type: SiteProperties | description: Site-level properties such as language, locale, timezone, and currency. - name: locale | type: SiteLocale | description: Site locale. - name: languageCode | type: string | description: Two-letter language code in ISO 639-1 alpha-2 format. | validation: maxLength 10 - name: country | type: string | description: Two-letter country code in ISO-3166 alpha-2 format. | validation: maxLength 10 - name: language | type: string | description: Site language code (e.g., "en"). | validation: maxLength 10 - name: paymentCurrency | type: string | description: Payment currency code (e.g., "EUR", "USD"). | validation: maxLength 10 - name: timeZone | type: string | description: IANA timezone identifier (e.g., "Europe/Dublin"). | validation: maxLength 100 - name: email | type: string | description: Contact email. | validation: maxLength 500 - name: phone | type: string | description: Contact phone. | validation: maxLength 100 - name: cmsCollections | type: array | description: CMS data collections defined on this site. Limited to the first 20 native collections. | validation: maxItems 20 - name: id | type: string | description: Collection GUID (also used as the collection name in CMS). | validation: maxLength 256 - name: displayName | type: string | description: Human-readable display name. | validation: maxLength 500 - name: fields | type: array | description: Field schemas in this collection. | validation: maxItems 500 - name: key | type: string | description: Field key (used in queries and data operations). | validation: maxLength 256 - name: displayName | type: string | description: Human-readable field name. | validation: maxLength 500 - name: type | type: CmsFieldType | description: The data type of the field. - enum: - UNKNOWN_FIELD_TYPE: Unknown or unsupported field type. - TEXT: Plain text. - NUMBER: Number. - DATE: Date (without time). - DATETIME: Date and time. - IMAGE: Image URL. - BOOLEAN: Boolean. - DOCUMENT: Document URL. - URL: URL. - RICH_TEXT: Rich text (HTML subset). - VIDEO: Video URL. - ANY: Any type. - ARRAY_STRING: Array of strings. - ARRAY_DOCUMENT: Array of documents. - AUDIO: Audio URL. - TIME: Time string. - LANGUAGE: Language code. - RICH_CONTENT: Rich content. - MEDIA_GALLERY: Media gallery. - ADDRESS: Address object. - PAGE_LINK: Dynamic page link. - REFERENCE: Single reference to another collection. - MULTI_REFERENCE: Multiple references to another collection. - OBJECT: JSON object. - ARRAY: Array. - name: description | type: string | description: Optional description of the field's purpose. | validation: maxLength 1000 - name: systemField | type: boolean | description: Whether this is a system field (`_id`, `_createdDate`, etc.). - name: referencedCollection | type: string | description: For `REFERENCE` / `MULTI_REFERENCE` fields: the referenced collection GUID. | validation: maxLength 256 - name: pagingMetadata | type: CursorPagingMetadata | description: Cursor-based paging metadata. Use `cursors.next` to retrieve the next page of results. - name: count | type: integer | description: Number of items returned in current page. | validation: format int32 - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. | validation: maxLength 16000 - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. | validation: maxLength 16000 - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. - name: partnerContext | type: PartnerContext | description: Partner account context. Present only when partner context resolution is enabled and a Partner Dashboard is found. - name: partner | type: boolean | description: Whether the calling account has a Partner Dashboard. - name: dashboardSiteId | type: string | description: Partner Dashboard metasite GUID. | validation: maxLength 36, format GUID - name: dashboardUrl | type: string | description: Partner Dashboard URL. | validation: maxLength 2048 ``` ### Examples ### Get Dynamic Context Retrieves aggregated site and account context for the authenticated user ```curl curl -X POST \ 'https://www.wixapis.com/_api/dynamic-context/v1/dynamic-context' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{}' ``` ---