About Wix APIs

Wix APIs are the programmatic interface to the Wix platform. They let your code do what site visitors and Wix users do through the Wix UI, from managing contacts and taking payments to querying site data and reacting to events on the site.

You can call Wix APIs from sites, headless projects, and from apps installed on sites. The same APIs work in each case. What changes between paths is how you authenticate and where your code runs, not the APIs themselves.

Wix APIs are designed to feel consistent across the platform. The same query language, the same identity model, and the same conventions for paging, errors, and field projection apply whether you're working with Stores, managing contacts, or processing a payment.

What you can do with Wix APIs

Wix APIs span the breadth of the platform. They reach Wix's business solutions, CMS and data, CRM data, media assets, site configuration, and more. The major API areas are:

• App Management: Manage installed apps and the app lifecycle, like reading app instance data or handling app installs and uninstalls.
• Business Solutions: Read and write data for Wix's business solutions like Stores, eCommerce, Bookings, Events, and Restaurants, such as creating an order, booking a session, or registering a guest.
• CMS and Data: Read and write content in a site's data collections, manage schemas, and query structured site content.
• Assets: Work with files, images, and other media in a site's media library.
• CRM: Manage the people in a site's audience, like updating a contact's email, tagging segments, or creating a member account.
• Business Management: Run business operations like payments, pricing plans, invoicing, marketing campaigns, and automations.
• Account Level: Manage account-wide settings that apply across sites, like users and collaborators.
• Site: Configure the site itself, like managing domains, redirects, multilingual settings, and SEO.

JavaScript SDK and REST

You can call most Wix APIs either through the JavaScript SDK or as a REST call. For those APIs, both forms reach the same underlying functionality, so the choice is about your language and runtime, not about what you can do.

The SDK is a set of typed npm packages that handles token management for you. It's the recommended option for sites and Wix-managed projects, and for self-managed projects running in JavaScript or TypeScript. If you're working in another language, use REST.

To learn about the SDK and REST APIs, see the unified API Reference.

Some SDK functionality has no REST counterpart because it's specific to the Wix environment or the JavaScript runtime. This includes host modules for the Wix dashboard, editor, and site, frontend modules for browser-side code, and core modules that handle Wix client setup and authentication. You'll find these documented in the standalone SDK Reference rather than the unified API Reference.

Other APIs

Developers extending Wix sites and building Blocks apps also use the legacy Velo API for page element manipulation ($w) and a small number of APIs not yet migrated to the SDK. New platform functionality is added to the SDK only. The Velo API is no longer receiving new additions.

Wix also offers a GraphQL API for querying and modifying a subset of the same data through a GraphQL endpoint. It can help when you need to combine multiple operations in one request or retrieve only specific fields from a larger object. For most projects, the JavaScript SDK or REST APIs are the better starting point.

APIs across development paths

The development path determines how your code authenticates to Wix APIs and which APIs are most natural to use:

• Sites: Use the SDK from backend or frontend code with authentication handled automatically. You import the SDK package you need and call it directly. A few APIs haven't yet been migrated from the legacy Velo API to the SDK and still need to be called through Velo.
• Wix-managed headless projects: Use the SDK from code running on Wix-hosted infrastructure, with authentication handled automatically. You import the SDK package you need and call it directly.
• Self-managed headless projects: Authentication isn't handled automatically. For SDK calls, you instantiate a Wix client with credentials. For REST calls, you manage auth tokens on each request.
• Wix-managed apps: Use the SDK from code running on Wix-hosted infrastructure, with authentication handled automatically. You import the SDK package you need and call it directly.
• Self-managed apps: Run on infrastructure you manage, so you handle authentication directly. For SDK calls, you instantiate a Wix client with credentials. For REST calls, you manage auth tokens on each request.
• Blocks apps: Use the SDK the same way sites do, including the Velo gap for APIs that haven't yet migrated.

See also

• Auth on the Wix Platform: How identity, permissions, and credentials shape what an API call is allowed to do.
• API Reference: The unified reference for every Wix API across REST and SDK.
• SDK Reference: The standalone reference for SDK-only functionality like host modules, frontend modules, and core modules.