# Meridian

> Documentation for Meridian — the all-in-one platform for Shopify app developers.

## Docs

- [Create addon](https://help.the-meridian.ai/api-reference/addons/create-addon.md)
- [Delete addon](https://help.the-meridian.ai/api-reference/addons/delete-addon.md)
- [Get addon](https://help.the-meridian.ai/api-reference/addons/get-addon.md)
- [List addons](https://help.the-meridian.ai/api-reference/addons/list-addons.md)
- [Update addon](https://help.the-meridian.ai/api-reference/addons/update-addon.md)
- [Connect app to Shopify (verify credentials)](https://help.the-meridian.ai/api-reference/apps/connect-app-to-shopify-verify-credentials.md)
- [Create app](https://help.the-meridian.ai/api-reference/apps/create-app.md)
- [Create app from GitHub repository](https://help.the-meridian.ai/api-reference/apps/create-app-from-github-repository.md)
- [Delete app (requires Shopify disconnected)](https://help.the-meridian.ai/api-reference/apps/delete-app-requires-shopify-disconnected.md)
- [Disconnect app from Shopify](https://help.the-meridian.ai/api-reference/apps/disconnect-app-from-shopify.md)
- [Get app](https://help.the-meridian.ai/api-reference/apps/get-app.md)
- [List apps in organization](https://help.the-meridian.ai/api-reference/apps/list-apps-in-organization.md)
- [Update app](https://help.the-meridian.ai/api-reference/apps/update-app.md)
- [Approve suspicious login attempt with emailed code](https://help.the-meridian.ai/api-reference/auth/approve-suspicious-login-attempt-with-emailed-code.md)
- [Approve suspicious login attempt with emailed link token](https://help.the-meridian.ai/api-reference/auth/approve-suspicious-login-attempt-with-emailed-link-token.md)
- [Authenticate using WebAuthn passkey assertion](https://help.the-meridian.ai/api-reference/auth/authenticate-using-webauthn-passkey-assertion.md)
- [Begin 2FA setup](https://help.the-meridian.ai/api-reference/auth/begin-2fa-setup.md)
- [Confirm 2FA setup](https://help.the-meridian.ai/api-reference/auth/confirm-2fa-setup.md)
- [Current authenticated user](https://help.the-meridian.ai/api-reference/auth/current-authenticated-user.md)
- [Delete authenticated account](https://help.the-meridian.ai/api-reference/auth/delete-authenticated-account.md)
- [Delete one passkey credential for authenticated user](https://help.the-meridian.ai/api-reference/auth/delete-one-passkey-credential-for-authenticated-user.md)
- [Disable 2FA](https://help.the-meridian.ai/api-reference/auth/disable-2fa.md)
- [Get WebAuthn assertion options for passkey login](https://help.the-meridian.ai/api-reference/auth/get-webauthn-assertion-options-for-passkey-login.md)
- [Get WebAuthn attestation options for passkey registration](https://help.the-meridian.ai/api-reference/auth/get-webauthn-attestation-options-for-passkey-registration.md)
- [List active API sessions for authenticated user](https://help.the-meridian.ai/api-reference/auth/list-active-api-sessions-for-authenticated-user.md)
- [List passkey credentials for authenticated user](https://help.the-meridian.ai/api-reference/auth/list-passkey-credentials-for-authenticated-user.md)
- [List recent login attempt history for authenticated user](https://help.the-meridian.ai/api-reference/auth/list-recent-login-attempt-history-for-authenticated-user.md)
- [Login with Apple token](https://help.the-meridian.ai/api-reference/auth/login-with-apple-token.md)
- [Login with email and password](https://help.the-meridian.ai/api-reference/auth/login-with-email-and-password.md)
- [Login with GitHub token](https://help.the-meridian.ai/api-reference/auth/login-with-github-token.md)
- [Login with Google token](https://help.the-meridian.ai/api-reference/auth/login-with-google-token.md)
- [Logout](https://help.the-meridian.ai/api-reference/auth/logout.md)
- [Register a new passkey credential for authenticated user](https://help.the-meridian.ai/api-reference/auth/register-a-new-passkey-credential-for-authenticated-user.md)
- [Register a new user and send verification email](https://help.the-meridian.ai/api-reference/auth/register-a-new-user-and-send-verification-email.md)
- [Resend verification email for unverified account](https://help.the-meridian.ai/api-reference/auth/resend-verification-email-for-unverified-account.md)
- [Reset password by token](https://help.the-meridian.ai/api-reference/auth/reset-password-by-token.md)
- [Revoke all active API sessions for authenticated user](https://help.the-meridian.ai/api-reference/auth/revoke-all-active-api-sessions-for-authenticated-user.md)
- [Revoke one active API session by token id](https://help.the-meridian.ai/api-reference/auth/revoke-one-active-api-session-by-token-id.md)
- [Send password reset email](https://help.the-meridian.ai/api-reference/auth/send-password-reset-email.md)
- [Set active organization](https://help.the-meridian.ai/api-reference/auth/set-active-organization.md)
- [Verify email from signed link](https://help.the-meridian.ai/api-reference/auth/verify-email-from-signed-link.md)
- [Verify pending 2FA challenge](https://help.the-meridian.ai/api-reference/auth/verify-pending-2fa-challenge.md)
- [Create custom domain](https://help.the-meridian.ai/api-reference/custom-domains/create-custom-domain.md)
- [Delete custom domain](https://help.the-meridian.ai/api-reference/custom-domains/delete-custom-domain.md)
- [Get custom domain](https://help.the-meridian.ai/api-reference/custom-domains/get-custom-domain.md)
- [List custom domains](https://help.the-meridian.ai/api-reference/custom-domains/list-custom-domains.md)
- [Sync custom domain certificate status](https://help.the-meridian.ai/api-reference/custom-domains/sync-custom-domain-certificate-status.md)
- [Create deployment](https://help.the-meridian.ai/api-reference/deployments/create-deployment.md)
- [Create deployment (app scoped)](https://help.the-meridian.ai/api-reference/deployments/create-deployment-app-scoped.md)
- [Get deployment](https://help.the-meridian.ai/api-reference/deployments/get-deployment.md)
- [List deployments](https://help.the-meridian.ai/api-reference/deployments/list-deployments.md)
- [Rollback deployment](https://help.the-meridian.ai/api-reference/deployments/rollback-deployment.md)
- [Create email](https://help.the-meridian.ai/api-reference/emails/create-email.md)
- [Delete email](https://help.the-meridian.ai/api-reference/emails/delete-email.md)
- [Get email with rendered HTML](https://help.the-meridian.ai/api-reference/emails/get-email-with-rendered-html.md)
- [List emails for app](https://help.the-meridian.ai/api-reference/emails/list-emails-for-app.md)
- [List sends for email](https://help.the-meridian.ai/api-reference/emails/list-sends-for-email.md)
- [Stream uploaded email-editor image](https://help.the-meridian.ai/api-reference/emails/stream-uploaded-email-editor-image.md): Mirrors file from backing storage (`email_uploads` disk). Anonymous; path is enforced via signed token only.
- [Update email](https://help.the-meridian.ai/api-reference/emails/update-email.md)
- [Update email status](https://help.the-meridian.ai/api-reference/emails/update-email-status.md)
- [Upload editor image to persistent bucket storage](https://help.the-meridian.ai/api-reference/emails/upload-editor-image-to-persistent-bucket-storage.md): Response `data.url` points at this API (`GET /app/uploads/email-media/{token}`), not direct GCS. Tokens are HMAC-signed so images load in `<img>` without Bearer auth while the bucket can stay non-public.
- [Create environment](https://help.the-meridian.ai/api-reference/environments/create-environment.md)
- [Delete environment](https://help.the-meridian.ai/api-reference/environments/delete-environment.md)
- [Enable database (deprecated)](https://help.the-meridian.ai/api-reference/environments/enable-database-deprecated.md)
- [List app environments](https://help.the-meridian.ai/api-reference/environments/list-app-environments.md)
- [Update environment](https://help.the-meridian.ai/api-reference/environments/update-environment.md)
- [Generate GitHub app installation URL](https://help.the-meridian.ai/api-reference/github/generate-github-app-installation-url.md)
- [Handle GitHub installation callback](https://help.the-meridian.ai/api-reference/github/handle-github-installation-callback.md)
- [List installation repositories](https://help.the-meridian.ai/api-reference/github/list-installation-repositories.md)
- [List installations](https://help.the-meridian.ai/api-reference/github/list-installations.md)
- [API health check](https://help.the-meridian.ai/api-reference/health/api-health-check.md)
- [Accept invitation token](https://help.the-meridian.ai/api-reference/invitations/accept-invitation-token.md)
- [Create organization](https://help.the-meridian.ai/api-reference/organizations/create-organization.md)
- [Delete organization](https://help.the-meridian.ai/api-reference/organizations/delete-organization.md)
- [Get organization](https://help.the-meridian.ai/api-reference/organizations/get-organization.md)
- [Invite collaborator](https://help.the-meridian.ai/api-reference/organizations/invite-collaborator.md)
- [Leave organization](https://help.the-meridian.ai/api-reference/organizations/leave-organization.md)
- [List collaborators in organization](https://help.the-meridian.ai/api-reference/organizations/list-collaborators-in-organization.md)
- [List organizations](https://help.the-meridian.ai/api-reference/organizations/list-organizations.md)
- [List pending collaborator invitations](https://help.the-meridian.ai/api-reference/organizations/list-pending-collaborator-invitations.md)
- [List permission catalog](https://help.the-meridian.ai/api-reference/organizations/list-permission-catalog.md)
- [Remove collaborator](https://help.the-meridian.ai/api-reference/organizations/remove-collaborator.md)
- [Update organization](https://help.the-meridian.ai/api-reference/organizations/update-organization.md)
- [List active addon plans](https://help.the-meridian.ai/api-reference/plans/list-active-addon-plans.md)
- [List active ecosystem plans](https://help.the-meridian.ai/api-reference/plans/list-active-ecosystem-plans.md)
- [List active feature plans for plane](https://help.the-meridian.ai/api-reference/plans/list-active-feature-plans-for-plane.md)
- [Get preview service](https://help.the-meridian.ai/api-reference/previews/get-preview-service.md)
- [List preview services](https://help.the-meridian.ai/api-reference/previews/list-preview-services.md)
- [Assign collaborator role](https://help.the-meridian.ai/api-reference/roles/assign-collaborator-role.md)
- [Configure role app scope (all apps or selected apps)](https://help.the-meridian.ai/api-reference/roles/configure-role-app-scope-all-apps-or-selected-apps.md): `app_scope=all` grants access to all current and future apps. `app_scope=selected` restricts access to `app_ids`. `app_scope=selected` with an empty `app_ids` array is valid and means no app access.
- [Create role](https://help.the-meridian.ai/api-reference/roles/create-role.md)
- [Delete role](https://help.the-meridian.ai/api-reference/roles/delete-role.md)
- [Get role](https://help.the-meridian.ai/api-reference/roles/get-role.md): Returns the role including `permission_ids`, `permissions`, `app_scope`, `app_ids`, and `apps` (display summaries for apps in the role-app pivot). When `app_scope` is `all`, `app_ids` and `apps` are empty; access applies to all apps in the organization.
- [List roles](https://help.the-meridian.ai/api-reference/roles/list-roles.md)
- [Replace collaborator direct permissions](https://help.the-meridian.ai/api-reference/roles/replace-collaborator-direct-permissions.md)
- [Replace role permissions](https://help.the-meridian.ai/api-reference/roles/replace-role-permissions.md)
- [Update role](https://help.the-meridian.ai/api-reference/roles/update-role.md)
- [Create app secret](https://help.the-meridian.ai/api-reference/secrets/create-app-secret.md)
- [Create environment secret](https://help.the-meridian.ai/api-reference/secrets/create-environment-secret.md)
- [Delete secret metadata record](https://help.the-meridian.ai/api-reference/secrets/delete-secret-metadata-record.md)
- [List app secret metadata](https://help.the-meridian.ai/api-reference/secrets/list-app-secret-metadata.md)
- [List environment secret metadata](https://help.the-meridian.ai/api-reference/secrets/list-environment-secret-metadata.md)
- [Rotate secret value](https://help.the-meridian.ai/api-reference/secrets/rotate-secret-value.md)
- [Create ecosystem checkout session](https://help.the-meridian.ai/api-reference/subscriptions/create-ecosystem-checkout-session.md)
- [Create feature checkout session](https://help.the-meridian.ai/api-reference/subscriptions/create-feature-checkout-session.md)
- [Receive GitHub webhook](https://help.the-meridian.ai/api-reference/webhooks/receive-github-webhook.md)
- [Receive Stripe webhook](https://help.the-meridian.ai/api-reference/webhooks/receive-stripe-webhook.md)
- [Shopify app analytics: MRR, churn, and installs](https://help.the-meridian.ai/app-store/analytics.md): Meridian's analytics dashboard surfaces MRR, ARR, active shops, churn rate, trial metrics, and CLV pulled live from the Shopify Partner API.
- [Monitor and respond to Shopify App Store reviews](https://help.the-meridian.ai/app-store/reviews.md): Track your app's star rating, read merchant feedback, respond to reviews, and use review insights to improve your App Store ranking in Meridian.
- [Run a pre-submission check before App Store review](https://help.the-meridian.ai/app-store/submission.md): Meridian scores your app across eight categories — installation, security, privacy, UX, and performance — so you fix issues before Shopify's reviewers do.
- [Log in and manage sessions in Meridian](https://help.the-meridian.ai/authentication.md): Meridian uses cookie-based authentication. Learn how to log in, verify your session, log out, and troubleshoot 401 errors and cookie issues.
- [Copy Polaris components from the Developer Toolkit](https://help.the-meridian.ai/build/developer-toolkit.md): Browse Meridian's Developer Toolkit to find ready-to-use Shopify Polaris components, full-page templates, and integration patterns with JSX and HTML examples.
- [Design Shopify app pricing with Plan Builder](https://help.the-meridian.ai/build/plan-builder.md): Use Meridian's Plan Builder to create subscription tiers, map feature entitlements to plans, and configure billing lifecycle events before you go live.
- [Get notified about Shopify API breaking changes](https://help.the-meridian.ai/build/shopify-api-alerts.md): Meridian's Shopify API Alerts monitor the Shopify changelog and classify every change by severity, impact area, and whether your specific app is affected.
- [Trigger deployments and roll back on Meridian](https://help.the-meridian.ai/deploy/deployments.md): Deploy your Shopify app from any Git branch or commit SHA, monitor build logs in real time, and roll back to a previous version with a single API call.
- [Create and manage deployment environments](https://help.the-meridian.ai/deploy/environments.md): Set up isolated production, staging, and development environments for your Shopify app. Each environment has its own secrets, region, and deployment history.
- [Managed hosting for your Shopify app on Meridian](https://help.the-meridian.ai/deploy/hosting.md): Meridian provides fully managed cloud hosting for Shopify apps. Learn how to enable hosting, choose a region, and add a managed database to any environment.
- [Capture and manage inbound leads from Meridian](https://help.the-meridian.ai/directory/leads.md): Handle contact form submissions from your public profile, route inquiries by keyword rules, and track conversion rate and response time in one dashboard.
- [Build your public Shopify developer profile](https://help.the-meridian.ai/directory/profile.md): Create a public Meridian profile to showcase your shipped apps, certifications, and testimonials. Improve your SEO score and attract inbound leads.
- [Build merchant lifecycle automations in Meridian](https://help.the-meridian.ai/grow/automations.md): Create event-triggered workflows for onboarding, retention, and engagement. Use Meridian's visual editor to connect triggers, actions, and email templates.
- [Track and manage merchants with Meridian CRM](https://help.the-meridian.ai/grow/crm.md): Meridian CRM syncs every merchant install from the Shopify Partner API. View profiles, charge history, subscription status, segments, and transaction data.
- [Create and send merchant emails with Meridian](https://help.the-meridian.ai/grow/emails.md): Design branded emails for your Shopify app's merchants using the built-in editor. Track open rates, click rates, and delivery status per send.
- [Meridian: the OS for Shopify app developers](https://help.the-meridian.ai/index.md): Meridian brings hosting, CRM, email, automations, App Store analytics, and developer tooling into one platform for Shopify app developers and agencies.
- [Meridian: build, deploy, and grow Shopify apps](https://help.the-meridian.ai/introduction.md): Meridian is the all-in-one platform for Shopify app developers. Host your app, manage merchants, send emails, track App Store rankings, and earn certifications.
- [Earn Shopify developer certifications on Meridian](https://help.the-meridian.ai/learn/certifications.md): Complete Meridian certification programs to validate your expertise, earn shareable badges, and appear as a certified developer or agency in the directory.
- [Shopify app development courses on Meridian](https://help.the-meridian.ai/learn/courses.md): Browse structured courses, step-by-step guides, tutorials, and playbooks on App Store optimization, deployment, UX, security, and architecture.
- [Get started with Meridian in 10 minutes](https://help.the-meridian.ai/quickstart.md): Create your Meridian account, connect your Shopify Partner credentials, link a GitHub repo, and push your first live deployment in under 10 minutes.

## OpenAPI Specs

- [api-docs](https://help.the-meridian.ai/api-docs.yaml)