picked 0.0.101 → 0.0.102-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/docs/reference/dashboard/workflow-test-runs.md +40 -17
  2. package/docs/reference/management-api/schema/action.md +67 -79
  3. package/docs/reference/management-api/schema/analytics-session.md +77 -94
  4. package/docs/reference/management-api/schema/analytics.md +16 -14
  5. package/docs/reference/management-api/schema/api-key.md +43 -51
  6. package/docs/reference/management-api/schema/auth.md +271 -404
  7. package/docs/reference/management-api/schema/cms-fields.md +348 -245
  8. package/docs/reference/management-api/schema/cms-models.md +369 -378
  9. package/docs/reference/management-api/schema/common.md +69 -130
  10. package/docs/reference/management-api/schema/condition.md +63 -74
  11. package/docs/reference/management-api/schema/design-system.md +59 -51
  12. package/docs/reference/management-api/schema/experience.md +388 -364
  13. package/docs/reference/management-api/schema/external-api.md +153 -171
  14. package/docs/reference/management-api/schema/feature.md +85 -103
  15. package/docs/reference/management-api/schema/feedback.md +27 -31
  16. package/docs/reference/management-api/schema/field.md +117 -135
  17. package/docs/reference/management-api/schema/index.md +184 -184
  18. package/docs/reference/management-api/schema/integration.md +72 -78
  19. package/docs/reference/management-api/schema/label.md +81 -137
  20. package/docs/reference/management-api/schema/lead.md +80 -119
  21. package/docs/reference/management-api/schema/mcp-server.md +73 -71
  22. package/docs/reference/management-api/schema/metric.md +6 -9
  23. package/docs/reference/management-api/schema/operation.md +17 -26
  24. package/docs/reference/management-api/schema/organization.md +198 -220
  25. package/docs/reference/management-api/schema/project.md +177 -186
  26. package/docs/reference/management-api/schema/report.md +69 -65
  27. package/docs/reference/management-api/schema/saved-view.md +71 -71
  28. package/docs/reference/management-api/schema/shopify.md +331 -204
  29. package/docs/reference/management-api/schema/step.md +72 -80
  30. package/docs/reference/management-api/schema/tenant-branding.md +48 -70
  31. package/docs/reference/management-api/schema/workbench.md +54 -66
  32. package/docs/reference/management-api/schema/workflow-run.md +66 -79
  33. package/docs/reference/management-api/schema/workflow.md +310 -353
  34. package/docs/reference/management-api/schema/workspace-version.md +212 -261
  35. package/docs/reference/management-api/schema/workspace.md +275 -328
  36. package/package.json +4 -4
@@ -21,190 +21,190 @@ An operation with `@auth` needs a caller that has authenticated. `@auth(only: US
21
21
 
22
22
  | Operation | Type | Description |
23
23
  | --- | --- | --- |
24
- | [`accountCreate`](/reference/management-api/schema/auth#accountcreate) | Mutation | Register an email address and send it a confirmation email. |
25
- | [`accountResendVerification`](/reference/management-api/schema/auth#accountresendverification) | Mutation | Resend the email verification link. |
26
- | [`accountVerifyEmail`](/reference/management-api/schema/auth#accountverifyemail) | Mutation | Verify a user's email address with a confirmation token. |
27
- | [`action`](/reference/management-api/schema/action#action) | Query | Get an action by ID within a workspace. |
28
- | [`actionCreate`](/reference/management-api/schema/action#actioncreate) | Mutation | Create a new action. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
29
- | [`actionDelete`](/reference/management-api/schema/action#actiondelete) | Mutation | Delete an action. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
30
- | [`actions`](/reference/management-api/schema/action#actions) | Query | List actions in a workspace. Filter by name with `search` (case-insensitive substring) and order with `sortKey` (default `NAME`) plus `reverse`. |
31
- | [`actionUpdate`](/reference/management-api/schema/action#actionupdate) | Mutation | Update an action. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
32
- | [`apiKeyCreate`](/reference/management-api/schema/api-key#apikeycreate) | Mutation | Create a new API key. Requires scope: `ORGANIZATION_API_KEYS_CREATE`. User authentication only (not API key). |
33
- | [`apiKeyRevoke`](/reference/management-api/schema/api-key#apikeyrevoke) | Mutation | Revoke an API key. Requires scope: `ORGANIZATION_API_KEYS_DELETE`. |
34
- | [`apiKeys`](/reference/management-api/schema/api-key#apikeys) | Query | List API keys for an organisation. Requires authentication. |
35
- | [`asset`](/reference/management-api/schema/cms-models#asset) | Query | Fetch a CMS Asset by id. |
36
- | [`assetCommit`](/reference/management-api/schema/cms-models#assetcommit) | Mutation | Finalise an Asset upload — captures size, MIME, and intrinsic dimensions for images. |
37
- | [`assetDelete`](/reference/management-api/schema/cms-models#assetdelete) | Mutation | Soft-delete an Asset. The underlying storage object is removed best-effort. |
38
- | [`assets`](/reference/management-api/schema/cms-models#assets) | Query | List CMS Assets in a project, with optional text search, MIME-type filtering, and sort. |
39
- | [`assetUploadInit`](/reference/management-api/schema/cms-models#assetuploadinit) | Mutation | Initiate an Asset upload — returns a pre-signed PUT URL plus the allocated asset id. |
40
- | [`condition`](/reference/management-api/schema/condition#condition) | Query | Get a condition by ID within a workspace. |
41
- | [`conditionCreate`](/reference/management-api/schema/condition#conditioncreate) | Mutation | Create a new condition. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
42
- | [`conditionDelete`](/reference/management-api/schema/condition#conditiondelete) | Mutation | Delete a condition. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
43
- | [`conditions`](/reference/management-api/schema/condition#conditions) | Query | List conditions in a workspace. Filter by name with `search` (case-insensitive substring) and order with `sortKey` (default `NAME`) plus `reverse`. |
44
- | [`conditionUpdate`](/reference/management-api/schema/condition#conditionupdate) | Mutation | Update a condition. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
45
- | [`contentBlock`](/reference/management-api/schema/cms-models#contentblock) | Query | Fetch a CMS Content Block by id. |
46
- | [`contentBlockCreate`](/reference/management-api/schema/cms-models#contentblockcreate) | Mutation | Create a new CMS Content Block. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
47
- | [`contentBlockDelete`](/reference/management-api/schema/cms-models#contentblockdelete) | Mutation | Soft-delete a CMS Content Block. |
48
- | [`contentBlocks`](/reference/management-api/schema/cms-models#contentblocks) | Query | List CMS Content Blocks in a workspace, optionally filtered by category. |
49
- | [`contentBlockUpdate`](/reference/management-api/schema/cms-models#contentblockupdate) | Mutation | Update a CMS Content Block schema. |
50
- | [`contentEntries`](/reference/management-api/schema/cms-models#contententries) | Query | List CMS Content Entries in a workspace, optionally filtered by parent Content Model. |
51
- | [`contentEntry`](/reference/management-api/schema/cms-models#contententry) | Query | Fetch a CMS Content Entry by id. |
52
- | [`contentEntryCreate`](/reference/management-api/schema/cms-models#contententrycreate) | Mutation | Create a new CMS Content Entry against a parent Content Model. |
53
- | [`contentEntryDelete`](/reference/management-api/schema/cms-models#contententrydelete) | Mutation | Soft-delete a CMS Content Entry. Refuses if a Step references it. |
54
- | [`contentEntryUpdate`](/reference/management-api/schema/cms-models#contententryupdate) | Mutation | Update a CMS Content Entry's data. |
55
- | [`contentModel`](/reference/management-api/schema/cms-models#contentmodel) | Query | Fetch a CMS Content Model by id. |
56
- | [`contentModelCreate`](/reference/management-api/schema/cms-models#contentmodelcreate) | Mutation | Create a new CMS Content Model. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
57
- | [`contentModelDelete`](/reference/management-api/schema/cms-models#contentmodeldelete) | Mutation | Soft-delete a CMS Content Model. Refuses if dependent Content Entry rows still exist. |
58
- | [`contentModels`](/reference/management-api/schema/cms-models#contentmodels) | Query | List CMS Content Models in a workspace, optionally filtered by category. |
59
- | [`contentModelUpdate`](/reference/management-api/schema/cms-models#contentmodelupdate) | Mutation | Update a CMS Content Model. Returns migration warnings when the schema change drops or coerces dependent Content Entry fields. |
60
- | [`createShopifyMetafieldConfig`](/reference/management-api/schema/shopify#createshopifymetafieldconfig) | Mutation | |
61
- | [`createShopifyWebhook`](/reference/management-api/schema/shopify#createshopifywebhook) | Mutation | |
62
- | [`deleteShopifyMetafieldConfig`](/reference/management-api/schema/shopify#deleteshopifymetafieldconfig) | Mutation | |
63
- | [`deleteShopifyWebhook`](/reference/management-api/schema/shopify#deleteshopifywebhook) | Mutation | |
64
- | [`designSystem`](/reference/management-api/schema/design-system#designsystem) | Query | Get a design system by ID. |
65
- | [`designSystemCreate`](/reference/management-api/schema/design-system#designsystemcreate) | Mutation | Create a new design system. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
66
- | [`designSystemDelete`](/reference/management-api/schema/design-system#designsystemdelete) | Mutation | Delete a design system. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
67
- | [`designSystems`](/reference/management-api/schema/design-system#designsystems) | Query | List design systems in a project. Filter by name with `search` (case-insensitive substring) and order with `sortKey` (default `NAME`) plus `reverse`. |
68
- | [`designSystemUpdate`](/reference/management-api/schema/design-system#designsystemupdate) | Mutation | Update a design system. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
69
- | [`emailLinkVerify`](/reference/management-api/schema/auth#emaillinkverify) | Mutation | Verify the link from a password-reset, invitation, sign-in or confirmation email and create a session. The link is single-use, so call this when the recipient confirms, never on opening the link: an email security scanner that opens links before delivery would otherwise use it up. |
70
- | [`experience`](/reference/management-api/schema/experience#experience) | Query | Get an experience by ID within a workspace. |
71
- | [`experienceCreate`](/reference/management-api/schema/experience#experiencecreate) | Mutation | Create a new experience. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
72
- | [`experienceDelete`](/reference/management-api/schema/experience#experiencedelete) | Mutation | Delete an experience. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
73
- | [`experienceFlowUpdate`](/reference/management-api/schema/experience#experienceflowupdate) | Mutation | Atomically save all changes to an experience flow. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
74
- | [`experiences`](/reference/management-api/schema/experience#experiences) | Query | List experiences within a workspace. Filter by name with `search` (case-insensitive substring) and order with `sortKey` (default `NAME`) plus `reverse`. |
75
- | [`experienceUpdate`](/reference/management-api/schema/experience#experienceupdate) | Mutation | Update an experience. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
76
- | [`externalApi`](/reference/management-api/schema/external-api#externalapi) | Query | Fetch a single external API by ID, or null if it does not exist. Requires authentication and `ORGANIZATION_INTEGRATIONS_READ` on its project. |
77
- | [`externalApiAuthHeaderClear`](/reference/management-api/schema/external-api#externalapiauthheaderclear) | Mutation | Remove the static auth header from an external API. Idempotent. Requires a user context and `ORGANIZATION_INTEGRATIONS_UPDATE`; API keys are rejected. |
78
- | [`externalApiAuthHeaderSet`](/reference/management-api/schema/external-api#externalapiauthheaderset) | Mutation | Set or replace the single static auth header on an external API, removing an OAuth2 credential it holds. Requires a user context and `ORGANIZATION_INTEGRATIONS_UPDATE`; API keys are rejected. |
79
- | [`externalApiCreate`](/reference/management-api/schema/external-api#externalapicreate) | Mutation | Register an external API to a project. Requires a user context and `ORGANIZATION_INTEGRATIONS_CREATE`; API keys are rejected. |
80
- | [`externalApiDelete`](/reference/management-api/schema/external-api#externalapidelete) | Mutation | Delete an external API registration and its encrypted credentials. Idempotent. Requires a user context and `ORGANIZATION_INTEGRATIONS_DELETE`; API keys are rejected. |
81
- | [`externalApiOAuth2Clear`](/reference/management-api/schema/external-api#externalapioauth2clear) | Mutation | Remove the OAuth2 credential, its secrets and its cached access token from an external API. Idempotent. Requires a user context and `ORGANIZATION_INTEGRATIONS_UPDATE`; API keys are rejected. |
82
- | [`externalApiOAuth2Set`](/reference/management-api/schema/external-api#externalapioauth2set) | Mutation | Set or replace the OAuth2 credential on an external API, removing a static auth header it holds. Requires a user context and `ORGANIZATION_INTEGRATIONS_UPDATE`; API keys are rejected. |
83
- | [`externalApiUpdate`](/reference/management-api/schema/external-api#externalapiupdate) | Mutation | Rename an external API. Requires a user context and `ORGANIZATION_INTEGRATIONS_UPDATE`; API keys are rejected. |
84
- | [`feature`](/reference/management-api/schema/feature#feature) | Query | Fetch a single feature by ID and workspace ID. Requires authentication. |
85
- | [`featureCreate`](/reference/management-api/schema/feature#featurecreate) | Mutation | Create a new feature. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
86
- | [`featureDelete`](/reference/management-api/schema/feature#featuredelete) | Mutation | Delete a feature. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
87
- | [`features`](/reference/management-api/schema/feature#features) | Query | List features in a workspace. Filter by name with `search` (case-insensitive substring) and order with `sortKey` (default `NAME`) plus `reverse`. |
88
- | [`featureUpdate`](/reference/management-api/schema/feature#featureupdate) | Mutation | Update a feature. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
89
- | [`feedbackCreate`](/reference/management-api/schema/feedback#feedbackcreate) | Mutation | Submit user feedback from the dashboard. Requires authentication (USER token only). |
90
- | [`field`](/reference/management-api/schema/field#field) | Query | Get a field by ID within a workspace. |
91
- | [`fieldCreate`](/reference/management-api/schema/field#fieldcreate) | Mutation | Create a new field. Requires scope: `ORGANIZATION_PROJECTS_CREATE`. |
92
- | [`fieldDelete`](/reference/management-api/schema/field#fielddelete) | Mutation | Delete a field. Requires scope: `ORGANIZATION_PROJECTS_DELETE`. |
93
- | [`fields`](/reference/management-api/schema/field#fields) | Query | Get list of fields within a workspace. |
94
- | [`fieldUpdate`](/reference/management-api/schema/field#fieldupdate) | Mutation | Update a field. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
95
- | [`integrationConfigurationCreate`](/reference/management-api/schema/integration#integrationconfigurationcreate) | Mutation | Create a configuration for an installed integration. Requires scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
96
- | [`integrationConfigurationDelete`](/reference/management-api/schema/integration#integrationconfigurationdelete) | Mutation | Delete an integration's configuration. Requires scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
97
- | [`integrationConfigurationUpdate`](/reference/management-api/schema/integration#integrationconfigurationupdate) | Mutation | Update an integration's configuration. Requires scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
98
- | [`integrationInstall`](/reference/management-api/schema/integration#integrationinstall) | Mutation | Install an integration for a project. Requires scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
99
- | [`integrationUninstall`](/reference/management-api/schema/integration#integrationuninstall) | Mutation | Uninstall an integration (cascades to delete all configurations). Requires scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
100
- | [`labelsDelete`](/reference/management-api/schema/label#labelsdelete) | Mutation | Remove labels from an owner. Requires scope: `ORGANIZATION_LEADS_UPDATE` on the lead's project for a `LEAD` owner, and `ORGANIZATION_PROJECTS_UPDATE` on the project for a `PROJECT` or `WORKFLOW_RUN` owner. |
101
- | [`labelsSet`](/reference/management-api/schema/label#labelsset) | Mutation | Create or replace labels on an owner. Requires scope: `ORGANIZATION_LEADS_UPDATE` on the lead's project for a `LEAD` owner, and `ORGANIZATION_PROJECTS_UPDATE` on the project for a `PROJECT` or `WORKFLOW_RUN` owner. |
102
- | [`lead`](/reference/management-api/schema/lead#lead) | Query | Get a lead by ID. Requires scope: `ORGANIZATION_LEADS_READ`. |
103
- | [`leadDelete`](/reference/management-api/schema/lead#leaddelete) | Mutation | Permanently delete a lead and its labels. Requires scope: `ORGANIZATION_LEADS_DELETE`. |
104
- | [`magicLinkSend`](/reference/management-api/schema/auth#magiclinksend) | Mutation | Email an existing account a sign-in code and link. Never creates an account, and answers `success: true` for an address with no account. |
105
- | [`magicLinkVerify`](/reference/management-api/schema/auth#magiclinkverify) | Mutation | Verify the code from a sign-in or confirmation email and create a session. |
106
- | [`mcpServer`](/reference/management-api/schema/mcp-server#mcpserver) | Query | Fetch a single registered MCP server by ID, or null if it doesn't exist. Requires authentication. |
107
- | [`mcpServerAuthHeaderClear`](/reference/management-api/schema/mcp-server#mcpserverauthheaderclear) | Mutation | Remove the auth header from an MCP server. Idempotent. Requires a user context; API keys are rejected. |
108
- | [`mcpServerAuthHeaderSet`](/reference/management-api/schema/mcp-server#mcpserverauthheaderset) | Mutation | Set or replace the single auth header on an MCP server. Requires a user context; API keys are rejected. |
109
- | [`mcpServerDelete`](/reference/management-api/schema/mcp-server#mcpserverdelete) | Mutation | Delete an MCP server registration and any encrypted credentials. Idempotent. |
110
- | [`mcpServerRegister`](/reference/management-api/schema/mcp-server#mcpserverregister) | Mutation | Register a new third-party MCP server. Requires a user context; API keys are rejected. |
111
- | [`mcpServerUpdate`](/reference/management-api/schema/mcp-server#mcpserverupdate) | Mutation | Update an MCP server's display name. URL rotation goes through `mcpServerUrlSet`. Requires a user context; API keys are rejected. |
112
- | [`mcpServerUrlSet`](/reference/management-api/schema/mcp-server#mcpserverurlset) | Mutation | Rotate the MCP server's URL. The new URL is encrypted; the response surfaces only the display URL. Requires a user context; API keys are rejected. |
113
- | [`mfaChallengeCreate`](/reference/management-api/schema/auth#mfachallengecreate) | Mutation | Open a challenge against one of the caller's factors. Requires a user session; exempt from the MFA policy. |
114
- | [`mfaChallengeVerify`](/reference/management-api/schema/auth#mfachallengeverify) | Mutation | Verify a code against a challenge and lift the caller's session to `AAL2`. Requires a user session; exempt from the MFA policy. |
115
- | [`mfaFactorEnroll`](/reference/management-api/schema/auth#mfafactorenroll) | Mutation | Enrol an authenticator app for the caller. Requires a user session; exempt from the MFA policy. |
116
- | [`mfaFactorUnenroll`](/reference/management-api/schema/auth#mfafactorunenroll) | Mutation | Remove one of the caller's factors. Requires a user session; exempt from the MFA policy, though removing a verified factor needs `AAL2`. |
117
- | [`oauthAuthorize`](/reference/management-api/schema/auth#oauthauthorize) | Mutation | Initiate an OAuth authorisation flow. |
118
- | [`oauthCallback`](/reference/management-api/schema/auth#oauthcallback) | Mutation | Handle the OAuth callback and create a session. |
119
- | [`oauthConsentApprove`](/reference/management-api/schema/auth#oauthconsentapprove) | Mutation | Approve an OAuth consent request. Requires authentication. |
120
- | [`oauthConsentDeny`](/reference/management-api/schema/auth#oauthconsentdeny) | Mutation | Deny an OAuth consent request. Requires authentication. |
121
- | [`oauthConsentDetails`](/reference/management-api/schema/auth#oauthconsentdetails) | Query | Get OAuth consent authorisation details. Requires authentication (USER token only). |
122
- | [`organization`](/reference/management-api/schema/organization#organization) | Query | Fetch a single organisation by ID or slug. Requires authentication. |
123
- | [`organizationClientManagerScopesUpdate`](/reference/management-api/schema/organization#organizationclientmanagerscopesupdate) | Mutation | Set the scopes a client manager holds in one organisation. Requires `STAFF_INVITE_CLIENT_MANAGER` at root. The target must be a client manager, and a caller may not edit their own scopes. A client manager may add or remove only scopes their own client-manager grant in that organisation carries; a super admin may set any. |
124
- | [`organizationCreate`](/reference/management-api/schema/organization#organizationcreate) | Mutation | Create a new organisation. Requires scope: `ORGANIZATION_CREATE`. |
125
- | [`organizationDelete`](/reference/management-api/schema/organization#organizationdelete) | Mutation | Delete an organisation. Requires scope: `ORGANIZATION_DELETE`. |
126
- | [`organizationInvitationAccept`](/reference/management-api/schema/organization#organizationinvitationaccept) | Mutation | Accept an organisation invitation. Requires authentication. |
127
- | [`organizationInvitationDecline`](/reference/management-api/schema/organization#organizationinvitationdecline) | Mutation | Decline an organisation invitation. Requires authentication. |
128
- | [`organizationInvitationRevoke`](/reference/management-api/schema/organization#organizationinvitationrevoke) | Mutation | Revoke an organisation invitation. Requires scope: `ORGANIZATION_INVITATIONS_DELETE`. |
129
- | [`organizationMemberInvite`](/reference/management-api/schema/organization#organizationmemberinvite) | Mutation | Invite a member to an organisation. Requires scope: `ORGANIZATION_INVITATIONS_CREATE`. |
130
- | [`organizationMemberRemove`](/reference/management-api/schema/organization#organizationmemberremove) | Mutation | Remove a member from an organisation. Requires scope: `ORGANIZATION_MEMBERS_DELETE`. |
131
- | [`organizationMemberScopesUpdate`](/reference/management-api/schema/organization#organizationmemberscopesupdate) | Mutation | Set the scopes a member holds in an organisation. Requires `ORGANIZATION_MEMBERS_MANAGE_SCOPES` reaching that organisation. The target must be a member. A caller may not grant a scope they do not themselves hold, and may not edit their own scopes. |
132
- | [`organizations`](/reference/management-api/schema/organization#organizations) | Query | List organisations the authenticated user belongs to. Requires authentication. |
133
- | [`organizationShopifyWebhooks`](/reference/management-api/schema/shopify#organizationshopifywebhooks) | Query | |
134
- | [`organizationUpdate`](/reference/management-api/schema/organization#organizationupdate) | Mutation | Update an organisation. Requires scope: `ORGANIZATION_UPDATE`. |
135
- | [`passwordResetSend`](/reference/management-api/schema/auth#passwordresetsend) | Mutation | Send a password reset email. |
136
- | [`passwordUpdate`](/reference/management-api/schema/auth#passwordupdate) | Mutation | Update the current user's password. Requires authentication. An `AAL1` session may set a password only while the user holds no verified factor, and is otherwise refused with `MFA_REQUIRED`. |
137
- | [`pickedqlQuery`](/reference/management-api/schema/analytics#pickedqlquery) | Query | Execute a PickedQL query scoped to the caller's authorised projects. |
138
- | [`ping`](/reference/management-api/schema/common#ping) | Query | Liveness probe used by infrastructure to confirm the GraphQL endpoint is up. Unauthenticated. |
139
- | [`project`](/reference/management-api/schema/project#project) | Query | Fetch a single project by ID. Requires authentication. |
140
- | [`projectCreate`](/reference/management-api/schema/project#projectcreate) | Mutation | Create a new project. Requires scope: `ORGANIZATION_PROJECTS_CREATE`. |
141
- | [`projectDelete`](/reference/management-api/schema/project#projectdelete) | Mutation | Delete a project. Requires scope: `ORGANIZATION_PROJECTS_DELETE`. |
142
- | [`projectPreviewEnvironmentCreate`](/reference/management-api/schema/project#projectpreviewenvironmentcreate) | Mutation | Create a project preview environment. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
143
- | [`projectPreviewEnvironmentDelete`](/reference/management-api/schema/project#projectpreviewenvironmentdelete) | Mutation | Delete a project preview environment. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
144
- | [`projectPreviewEnvironmentUpdate`](/reference/management-api/schema/project#projectpreviewenvironmentupdate) | Mutation | Update a project preview environment. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
145
- | [`projects`](/reference/management-api/schema/project#projects) | Query | List projects the authenticated user can reach, across every organisation they belong to. Pass `organizationId` to narrow the list to one organisation, and `search` to match project names case-insensitively. Requires authentication. |
146
- | [`projectShopifyMetafieldConfigs`](/reference/management-api/schema/shopify#projectshopifymetafieldconfigs) | Query | |
147
- | [`projectUpdate`](/reference/management-api/schema/project#projectupdate) | Mutation | Update a project. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
148
- | [`report`](/reference/management-api/schema/report#report) | Query | Fetch a single report by id. Requires authentication. |
149
- | [`reportCreate`](/reference/management-api/schema/report#reportcreate) | Mutation | Create a new report. Requires scope: `ORGANIZATION_REPORTS_CREATE`. |
150
- | [`reportDelete`](/reference/management-api/schema/report#reportdelete) | Mutation | Delete a report. Requires scope: `ORGANIZATION_REPORTS_DELETE`. |
151
- | [`reportUpdate`](/reference/management-api/schema/report#reportupdate) | Mutation | Update a report. Requires scope: `ORGANIZATION_REPORTS_UPDATE`. |
152
- | [`savedView`](/reference/management-api/schema/saved-view#savedview) | Query | Get a saved view by ID. Requires scope: `ORGANIZATION_PROJECTS_READ`. |
153
- | [`savedViewCreate`](/reference/management-api/schema/saved-view#savedviewcreate) | Mutation | Save a view of a project's list. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
154
- | [`savedViewDelete`](/reference/management-api/schema/saved-view#savedviewdelete) | Mutation | Delete a saved view. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
155
- | [`savedViewUpdate`](/reference/management-api/schema/saved-view#savedviewupdate) | Mutation | Rename a saved view, change what it restores, or move the default. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
156
- | [`sessionCreate`](/reference/management-api/schema/auth#sessioncreate) | Mutation | Create a new session by signing in with email and password. |
157
- | [`sessionRefresh`](/reference/management-api/schema/auth#sessionrefresh) | Mutation | Refresh an existing session using a refresh token. |
158
- | [`sessionStart`](/reference/management-api/schema/auth#sessionstart) | Mutation | Begin signing in with an email address alone. Answers `PASSWORD` when the account has set a password, and otherwise emails a sign-in code and link and answers `EMAIL_CODE`. Never creates an account. Returns `RATE_LIMITED` when the caller makes too many requests, or when the project's email quota is spent. |
159
- | [`shopifyCollectionContentUpdate`](/reference/management-api/schema/shopify#shopifycollectioncontentupdate) | Mutation | Update Shopify collection content. Requires authentication. |
160
- | [`shopifyMetafieldConfigCreate`](/reference/management-api/schema/shopify#shopifymetafieldconfigcreate) | Mutation | Create a Shopify metafield config. Requires authentication. |
161
- | [`shopifyMetafieldConfigDelete`](/reference/management-api/schema/shopify#shopifymetafieldconfigdelete) | Mutation | Delete a Shopify metafield config. Requires authentication. |
162
- | [`shopifyMetafieldConfigs`](/reference/management-api/schema/shopify#shopifymetafieldconfigs) | Query | List Shopify metafield configs for a project. Requires authentication. |
163
- | [`shopifyMetafieldConfigUpdate`](/reference/management-api/schema/shopify#shopifymetafieldconfigupdate) | Mutation | Update a Shopify metafield config. Requires authentication. |
164
- | [`shopifyProduct`](/reference/management-api/schema/shopify#shopifyproduct) | Query | |
165
- | [`shopifyProductContentUpdate`](/reference/management-api/schema/shopify#shopifyproductcontentupdate) | Mutation | Update Shopify product content. Requires authentication. |
166
- | [`shopifyProducts`](/reference/management-api/schema/shopify#shopifyproducts) | Query | |
167
- | [`shopifyWebhookCreate`](/reference/management-api/schema/shopify#shopifywebhookcreate) | Mutation | Create a new Shopify webhook. Requires authentication. |
168
- | [`shopifyWebhookDelete`](/reference/management-api/schema/shopify#shopifywebhookdelete) | Mutation | Delete a Shopify webhook. Requires authentication. |
169
- | [`shopifyWebhooks`](/reference/management-api/schema/shopify#shopifywebhooks) | Query | List Shopify webhooks for an organisation. Requires authentication. |
170
- | [`shopifyWebhookUpdate`](/reference/management-api/schema/shopify#shopifywebhookupdate) | Mutation | Update a Shopify webhook. Requires authentication. |
171
- | [`step`](/reference/management-api/schema/step#step) | Query | Get a step by ID within a workspace. |
172
- | [`stepCreate`](/reference/management-api/schema/step#stepcreate) | Mutation | Create a new step. Requires scope: `ORGANIZATION_PROJECTS_CREATE`. |
173
- | [`stepDelete`](/reference/management-api/schema/step#stepdelete) | Mutation | Delete a step. Requires scope: `ORGANIZATION_PROJECTS_DELETE`. |
174
- | [`steps`](/reference/management-api/schema/step#steps) | Query | Get list of steps within a workspace. |
175
- | [`stepUpdate`](/reference/management-api/schema/step#stepupdate) | Mutation | Update a step. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
176
- | [`tenant`](/reference/management-api/schema/tenant-branding#tenant) | Query | Resolve a tenant (and its branding) by host or explicit slug. Unauthenticated; cached for 5 minutes. |
177
- | [`updateShopifyCollectionContent`](/reference/management-api/schema/shopify#updateshopifycollectioncontent) | Mutation | |
178
- | [`updateShopifyMetafieldConfig`](/reference/management-api/schema/shopify#updateshopifymetafieldconfig) | Mutation | |
179
- | [`updateShopifyProductContent`](/reference/management-api/schema/shopify#updateshopifyproductcontent) | Mutation | |
180
- | [`updateShopifyWebhook`](/reference/management-api/schema/shopify#updateshopifywebhook) | Mutation | |
181
- | [`user`](/reference/management-api/schema/auth#user) | Query | Fetch the currently authenticated user. Returns null if the request is unauthenticated. Exempt from the MFA policy, so a gated user can read `mfa` and `mfaFactors`. |
182
- | [`viewerScopes`](/reference/management-api/schema/auth#viewerscopes) | Query | Root-level scopes for the authenticated user (e.g. `ORGANIZATION_CREATE`, `STAFF_READ`). Use `Organization.viewerScopes` for org-scoped scopes. |
183
- | [`workbenchAssetAdoptOwned`](/reference/management-api/schema/workbench#workbenchassetadoptowned) | Mutation | Adopts an existing project-library Asset as `OWNED` by a Workbench, transferring the Asset's ownership. Used when a Create-Page upload is bound to its Workbench after the Workbench is created. |
184
- | [`workbenchAssetImport`](/reference/management-api/schema/workbench#workbenchassetimport) | Mutation | Imports an Asset owned elsewhere into a Workbench, creating an `IMPORTED` membership. Removing the import (`workbenchAssetRemove`) drops only the join, never the Asset. |
185
- | [`workbenchAssetRemove`](/reference/management-api/schema/workbench#workbenchassetremove) | Mutation | Removes an Asset's membership from a Workbench. If the membership was `OWNED`, the Asset is also soft-deleted; if `IMPORTED`, only the join is dropped. |
186
- | [`workflow`](/reference/management-api/schema/workflow#workflow) | Query | Get a workflow by ID. |
187
- | [`workflowCreate`](/reference/management-api/schema/workflow#workflowcreate) | Mutation | Create a new workflow. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
188
- | [`workflowDelete`](/reference/management-api/schema/workflow#workflowdelete) | Mutation | Delete a workflow. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
189
- | [`workflowGraphUpdate`](/reference/management-api/schema/workflow#workflowgraphupdate) | Mutation | Apply a batch of changes to a workflow's graph, all or nothing. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
190
- | [`workflowRun`](/reference/management-api/schema/workflow-run#workflowrun) | Query | Get a workflow run by ID. Requires scope: `ORGANIZATION_PROJECTS_READ`. |
191
- | [`workflows`](/reference/management-api/schema/workflow#workflows) | Query | List workflows in a workspace. Filter by name with `search` (case-insensitive substring) and order with `sortKey` (default `NAME`) plus `reverse`. |
192
- | [`workflowTestRun`](/reference/management-api/schema/workflow#workflowtestrun) | Mutation | Walk a workflow's draft graph once against a supplied trigger input, holding every write back, and return what each node did. Nothing is stored. Requires scope `ORGANIZATION_WORKSPACE_UPDATE` and every scope in `Workflow.scopes`; a refusal names each one missing. |
193
- | [`workflowTools`](/reference/management-api/schema/workflow#workflowtools) | Query | Every tool a workflow node may run, with the arguments each accepts. Read by the editor to build its node palette. |
194
- | [`workflowUpdate`](/reference/management-api/schema/workflow#workflowupdate) | Mutation | Update a workflow. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
195
- | [`workspace`](/reference/management-api/schema/workspace#workspace) | Query | Get a specific workspace. Requires authentication. |
196
- | [`workspaceArchive`](/reference/management-api/schema/workspace#workspacearchive) | Mutation | Archive a non-live workspace. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
197
- | [`workspaceContentEntryValidation`](/reference/management-api/schema/cms-models#workspacecontententryvalidation) | Query | Run schema validation across every Content Entry in a workspace and report which rows no longer conform. Read-only — does not auto-fix. Useful as a pre-publish sanity gate, especially after a Content Block schema change. Optionally narrow the sweep to a single Content Model with `contentModelId`. |
198
- | [`workspaceCreate`](/reference/management-api/schema/workspace#workspacecreate) | Mutation | Create a new workspace on a project. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
199
- | [`workspaceDelete`](/reference/management-api/schema/workspace#workspacedelete) | Mutation | Soft-delete a non-live workspace. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
200
- | [`workspaceDiff`](/reference/management-api/schema/workspace-version#workspacediff) | Query | Compute a structural diff between two workspace snapshots. Each side can be either a live workspace (diffed against its current draft snapshot) or a previously-published `WorkspaceVersion`. Requires authentication and `ORGANIZATION_PROJECTS_READ` scope on the project shared by both sides. |
201
- | [`workspaceDuplicate`](/reference/management-api/schema/workspace#workspaceduplicate) | Mutation | Duplicate an existing workspace with all of its child entities, including its workflows. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
202
- | [`workspaceExport`](/reference/management-api/schema/workspace#workspaceexport) | Query | Export a workspace and every entity in it as a portable JSON bundle, with a manifest of the asset versions its content references. The asset bytes are not included; download each from its `downloadUrl`. Requires scope: `ORGANIZATION_PROJECTS_READ` on the workspace's project. |
203
- | [`workspaceImport`](/reference/management-api/schema/workspace#workspaceimport) | Mutation | Create a new draft workspace in a project from a bundle returned by `workspaceExport`, committing every entity in one transaction. Requires scope: `ORGANIZATION_PROJECTS_UPDATE` on the target project. |
204
- | [`workspacePublish`](/reference/management-api/schema/workspace#workspacepublish) | Mutation | Publish a workspace, creating an immutable version snapshot. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
205
- | [`workspaceUnarchive`](/reference/management-api/schema/workspace#workspaceunarchive) | Mutation | Unarchive an archived workspace (restores it to `DRAFT`). Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
206
- | [`workspaceUpdate`](/reference/management-api/schema/workspace#workspaceupdate) | Mutation | Rename an existing workspace. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
207
- | [`workspaceVersionPublish`](/reference/management-api/schema/workspace#workspaceversionpublish) | Mutation | Promote a previously-published `WorkspaceVersion` to be its project's served (live) version by pointing `projects.live_workspace_version_id` at it and stamping the owning workspace's `publishedAt` with that version's original publish timestamp. Works for the latest version (re-publish) or an earlier one (rollback, in product terms). No new `WorkspaceVersion` row is appended. The target workspace becomes the project's live one (an archived workspace is un-archived). The draft state is NOT modified, so if the draft differs from the published snapshot it shows up as "unpublished changes" in the UI. Use `workspaceDiff` with `(baseWorkspaceId, compareWorkspaceVersionId)` to preview the impact before invoking this mutation. Requires scope: `ORGANIZATION_PROJECTS_UPDATE`. |
24
+ | [`accountCreate`](/reference/management-api/schema/auth#accountcreate) | Mutation | Registers an email address and emails it a confirmation code and link. The response does not reveal whether the address has an account. Returns `RATE_LIMITED` when the project's email quota is spent. |
25
+ | [`accountResendVerification`](/reference/management-api/schema/auth#accountresendverification) | Mutation | Emails an existing account a new code and link: a confirmation, or a sign-in for a confirmed account. An address with no account returns an error, so the response reveals whether an account exists. An address emailed within the minimum send interval returns `RATE_LIMITED`. |
26
+ | [`accountVerifyEmail`](/reference/management-api/schema/auth#accountverifyemail) | Mutation | Verifies the six-digit code from a confirmation or sign-in email and creates a session. |
27
+ | [`action`](/reference/management-api/schema/action#action) | Query | Reads an action. Scope: `ORGANIZATION_WORKSPACE_READ`. |
28
+ | [`actionCreate`](/reference/management-api/schema/action#actioncreate) | Mutation | Creates an action in a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
29
+ | [`actionDelete`](/reference/management-api/schema/action#actiondelete) | Mutation | Deletes an action and the workflow it starts. An action that an experience references is not deleted, and comes back as an `IN_USE` user error. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
30
+ | [`actions`](/reference/management-api/schema/action#actions) | Query | Lists the actions in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
31
+ | [`actionUpdate`](/reference/management-api/schema/action#actionupdate) | Mutation | Updates an action. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
32
+ | [`apiKeyCreate`](/reference/management-api/schema/api-key#apikeycreate) | Mutation | Creates an API key and returns the full key, once. A blank name, no scopes, or a scope the caller does not hold or the key cannot carry returns `VALIDATION_ERROR`. Scope: `ORGANIZATION_API_KEYS_CREATE`. |
33
+ | [`apiKeyRevoke`](/reference/management-api/schema/api-key#apikeyrevoke) | Mutation | Revokes an API key, which then stops authenticating at once. Cannot be undone; an unknown or revoked key returns `NOT_FOUND`. Scope: `ORGANIZATION_API_KEYS_DELETE`. |
34
+ | [`apiKeys`](/reference/management-api/schema/api-key#apikeys) | Query | Lists an organisation's API keys, newest first. Revoked keys are left out. Scope: `ORGANIZATION_API_KEYS_READ`. |
35
+ | [`asset`](/reference/management-api/schema/cms-models#asset) | Query | Reads an asset. Scope: `ORGANIZATION_PROJECTS_READ`. |
36
+ | [`assetCommit`](/reference/management-api/schema/cms-models#assetcommit) | Mutation | Commits an uploaded file as the asset's current version, recording its size, MIME type and image dimensions. Fails when the bytes do not match the claimed content type. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
37
+ | [`assetDelete`](/reference/management-api/schema/cms-models#assetdelete) | Mutation | Deletes an asset and its stored files. Fails with `CONFLICT` once a publish uses any of its versions; content entries that reference it are not checked. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
38
+ | [`assets`](/reference/management-api/schema/cms-models#assets) | Query | Lists the assets in a project, newest first by default. Scope: `ORGANIZATION_PROJECTS_READ`. |
39
+ | [`assetUploadInit`](/reference/management-api/schema/cms-models#assetuploadinit) | Mutation | Starts an asset upload and returns a pre-signed URL to PUT the bytes to. Nothing is stored until `assetCommit`. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
40
+ | [`condition`](/reference/management-api/schema/condition#condition) | Query | Reads a condition. Scope: `ORGANIZATION_WORKSPACE_READ`. |
41
+ | [`conditionCreate`](/reference/management-api/schema/condition#conditioncreate) | Mutation | Creates a condition in a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
42
+ | [`conditionDelete`](/reference/management-api/schema/condition#conditiondelete) | Mutation | Deletes a condition. A condition that an experience or another condition references is not deleted, and comes back as an `IN_USE` user error. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
43
+ | [`conditions`](/reference/management-api/schema/condition#conditions) | Query | Lists the conditions in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
44
+ | [`conditionUpdate`](/reference/management-api/schema/condition#conditionupdate) | Mutation | Updates a condition. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
45
+ | [`contentBlock`](/reference/management-api/schema/cms-models#contentblock) | Query | Reads a block. Scope: `ORGANIZATION_WORKSPACE_READ`. |
46
+ | [`contentBlockCreate`](/reference/management-api/schema/cms-models#contentblockcreate) | Mutation | Creates a block. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
47
+ | [`contentBlockDelete`](/reference/management-api/schema/cms-models#contentblockdelete) | Mutation | Deletes a block. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
48
+ | [`contentBlocks`](/reference/management-api/schema/cms-models#contentblocks) | Query | Lists the blocks in a workspace. Scope: `ORGANIZATION_WORKSPACE_READ`. |
49
+ | [`contentBlockUpdate`](/reference/management-api/schema/cms-models#contentblockupdate) | Mutation | Updates a block. A schema change does not migrate the content entries that embed it. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
50
+ | [`contentEntries`](/reference/management-api/schema/cms-models#contententries) | Query | Lists the content entries in a workspace. Scope: `ORGANIZATION_WORKSPACE_READ`. |
51
+ | [`contentEntry`](/reference/management-api/schema/cms-models#contententry) | Query | Reads a content entry. Scope: `ORGANIZATION_WORKSPACE_READ`. |
52
+ | [`contentEntryCreate`](/reference/management-api/schema/cms-models#contententrycreate) | Mutation | Creates a content entry of a model. Each asset reference without a version is pinned to the asset's current version. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
53
+ | [`contentEntryDelete`](/reference/management-api/schema/cms-models#contententrydelete) | Mutation | Deletes a content entry. Fails with `CONFLICT` while a step uses it as its layout, or while another content entry references it. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
54
+ | [`contentEntryUpdate`](/reference/management-api/schema/cms-models#contententryupdate) | Mutation | Updates the data of a content entry. Each asset reference without a version is pinned to the asset's current version. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
55
+ | [`contentModel`](/reference/management-api/schema/cms-models#contentmodel) | Query | Reads a model. Scope: `ORGANIZATION_WORKSPACE_READ`. |
56
+ | [`contentModelCreate`](/reference/management-api/schema/cms-models#contentmodelcreate) | Mutation | Creates a model. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
57
+ | [`contentModelDelete`](/reference/management-api/schema/cms-models#contentmodeldelete) | Mutation | Deletes a model. Fails with `CONFLICT` while content entries use it, or while another schema's reference field targets it. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
58
+ | [`contentModels`](/reference/management-api/schema/cms-models#contentmodels) | Query | Lists the models in a workspace. Scope: `ORGANIZATION_WORKSPACE_READ`. |
59
+ | [`contentModelUpdate`](/reference/management-api/schema/cms-models#contentmodelupdate) | Mutation | Updates a model. A schema change migrates the data of its content entries and lists each removed value in `migrationWarnings`. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
60
+ | [`createShopifyMetafieldConfig`](/reference/management-api/schema/shopify#createshopifymetafieldconfig) | Mutation | Creates a Shopify metafield config for a project. Scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
61
+ | [`createShopifyWebhook`](/reference/management-api/schema/shopify#createshopifywebhook) | Mutation | Creates a Shopify webhook for a project and generates its HMAC secret. The result is the only place the secret appears. Scope: `ORGANIZATION_INTEGRATIONS_CREATE` and `ORGANIZATION_INTEGRATIONS_READ`. |
62
+ | [`deleteShopifyMetafieldConfig`](/reference/management-api/schema/shopify#deleteshopifymetafieldconfig) | Mutation | Deletes a Shopify metafield config. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
63
+ | [`deleteShopifyWebhook`](/reference/management-api/schema/shopify#deleteshopifywebhook) | Mutation | Deletes a Shopify webhook. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
64
+ | [`designSystem`](/reference/management-api/schema/design-system#designsystem) | Query | Reads a design system. Scope: `ORGANIZATION_PROJECTS_READ`. |
65
+ | [`designSystemCreate`](/reference/management-api/schema/design-system#designsystemcreate) | Mutation | Creates a design system from a committed Markdown asset. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
66
+ | [`designSystemDelete`](/reference/management-api/schema/design-system#designsystemdelete) | Mutation | Deletes a design system. The asset that holds its guidance is kept. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
67
+ | [`designSystems`](/reference/management-api/schema/design-system#designsystems) | Query | Lists the design systems in a project. Scope: `ORGANIZATION_PROJECTS_READ`. |
68
+ | [`designSystemUpdate`](/reference/management-api/schema/design-system#designsystemupdate) | Mutation | Updates a design system's name or guidance asset. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
69
+ | [`emailLinkVerify`](/reference/management-api/schema/auth#emaillinkverify) | Mutation | Verifies the link from a password-reset, invitation, sign-in or confirmation email and creates a session. The link works once: call this when the recipient confirms, never on opening the link, which an email security scanner may do before delivery. |
70
+ | [`experience`](/reference/management-api/schema/experience#experience) | Query | Reads an experience. Scope: `ORGANIZATION_WORKSPACE_READ`. |
71
+ | [`experienceCreate`](/reference/management-api/schema/experience#experiencecreate) | Mutation | Creates an experience in a workspace. A `PAGE` experience gets its single step and flow graph automatically. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
72
+ | [`experienceDelete`](/reference/management-api/schema/experience#experiencedelete) | Mutation | Deletes an experience. Its steps, conditions and actions stay in the workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
73
+ | [`experienceFlowUpdate`](/reference/management-api/schema/experience#experienceflowupdate) | Mutation | Updates an experience's settings and flow graph, with the steps, conditions, actions and fields it uses, in one call. Validation runs before any write, and a change that fails it fails the whole call. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
74
+ | [`experiences`](/reference/management-api/schema/experience#experiences) | Query | Lists the experiences in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
75
+ | [`experienceUpdate`](/reference/management-api/schema/experience#experienceupdate) | Mutation | Updates an experience's settings. `experienceFlowUpdate` changes its flow graph. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
76
+ | [`externalApi`](/reference/management-api/schema/external-api#externalapi) | Query | Reads an external API. Null when it does not exist. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
77
+ | [`externalApiAuthHeaderClear`](/reference/management-api/schema/external-api#externalapiauthheaderclear) | Mutation | Removes the static auth header of an external API. An external API with no static header is unchanged. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
78
+ | [`externalApiAuthHeaderSet`](/reference/management-api/schema/external-api#externalapiauthheaderset) | Mutation | Sets the static auth header of an external API, and removes any OAuth2 credential. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
79
+ | [`externalApiCreate`](/reference/management-api/schema/external-api#externalapicreate) | Mutation | Creates an external API in a project, with an optional credential. Scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
80
+ | [`externalApiDelete`](/reference/management-api/schema/external-api#externalapidelete) | Mutation | Deletes an external API and its credential. Workflows then cannot call its origin. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
81
+ | [`externalApiOAuth2Clear`](/reference/management-api/schema/external-api#externalapioauth2clear) | Mutation | Removes the OAuth2 credential of an external API, with its secrets and cached access token. An external API with no OAuth2 credential is unchanged. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
82
+ | [`externalApiOAuth2Set`](/reference/management-api/schema/external-api#externalapioauth2set) | Mutation | Sets the OAuth2 credential of an external API, and removes any static auth header. The next call fetches a new access token. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
83
+ | [`externalApiUpdate`](/reference/management-api/schema/external-api#externalapiupdate) | Mutation | Updates the name of an external API. To change the origin, delete it and create another. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
84
+ | [`feature`](/reference/management-api/schema/feature#feature) | Query | Reads a feature flag by its ID and workspace. Scope: `ORGANIZATION_WORKSPACE_READ`. |
85
+ | [`featureCreate`](/reference/management-api/schema/feature#featurecreate) | Mutation | Creates a feature flag in a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
86
+ | [`featureDelete`](/reference/management-api/schema/feature#featuredelete) | Mutation | Deletes a feature flag. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
87
+ | [`features`](/reference/management-api/schema/feature#features) | Query | Lists the feature flags in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
88
+ | [`featureUpdate`](/reference/management-api/schema/feature#featureupdate) | Mutation | Updates a feature flag. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
89
+ | [`feedbackCreate`](/reference/management-api/schema/feedback#feedbackcreate) | Mutation | Sends product feedback from the signed-in user to the Picked team. |
90
+ | [`field`](/reference/management-api/schema/field#field) | Query | Reads a field. Scope: `ORGANIZATION_WORKSPACE_READ`. |
91
+ | [`fieldCreate`](/reference/management-api/schema/field#fieldcreate) | Mutation | Creates a field in a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
92
+ | [`fieldDelete`](/reference/management-api/schema/field#fielddelete) | Mutation | Deletes a field. A field that is on a step is not deleted, and comes back as an `IN_USE` user error. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
93
+ | [`fields`](/reference/management-api/schema/field#fields) | Query | Lists the fields in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
94
+ | [`fieldUpdate`](/reference/management-api/schema/field#fieldupdate) | Mutation | Updates a field. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
95
+ | [`integrationConfigurationCreate`](/reference/management-api/schema/integration#integrationconfigurationcreate) | Mutation | Creates the configuration of an installed integration. An integration has at most one configuration; a second gets a `CONFLICT` error. Scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
96
+ | [`integrationConfigurationDelete`](/reference/management-api/schema/integration#integrationconfigurationdelete) | Mutation | Deletes an integration's configuration. The integration stays installed. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
97
+ | [`integrationConfigurationUpdate`](/reference/management-api/schema/integration#integrationconfigurationupdate) | Mutation | Updates an integration's configuration. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
98
+ | [`integrationInstall`](/reference/management-api/schema/integration#integrationinstall) | Mutation | Installs an integration for a project. A project that already has an integration of that type gets a `CONFLICT` error. Scope: `ORGANIZATION_INTEGRATIONS_CREATE` and `ORGANIZATION_PROJECTS_READ`. |
99
+ | [`integrationUninstall`](/reference/management-api/schema/integration#integrationuninstall) | Mutation | Uninstalls an integration and deletes its configuration. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
100
+ | [`labelsDelete`](/reference/management-api/schema/label#labelsdelete) | Mutation | Deletes labels from a lead, a project or a workflow run. Deleting a label that is not set succeeds. A `LEAD` owner needs `ORGANIZATION_LEADS_UPDATE`; the other owners need `ORGANIZATION_PROJECTS_UPDATE`. Scope: `ORGANIZATION_LEADS_UPDATE` or `ORGANIZATION_PROJECTS_UPDATE`. |
101
+ | [`labelsSet`](/reference/management-api/schema/label#labelsset) | Mutation | Creates or replaces labels on a lead, a project or a workflow run. Labels the call does not name are unchanged. A `LEAD` owner needs `ORGANIZATION_LEADS_UPDATE`; the other owners need `ORGANIZATION_PROJECTS_UPDATE`. Scope: `ORGANIZATION_LEADS_UPDATE` or `ORGANIZATION_PROJECTS_UPDATE`. |
102
+ | [`lead`](/reference/management-api/schema/lead#lead) | Query | Reads a lead. Scope: `ORGANIZATION_LEADS_READ`. |
103
+ | [`leadDelete`](/reference/management-api/schema/lead#leaddelete) | Mutation | Deletes a lead and its labels. This cannot be undone. Scope: `ORGANIZATION_LEADS_DELETE`. |
104
+ | [`magicLinkSend`](/reference/management-api/schema/auth#magiclinksend) | Mutation | Emails an existing account a sign-in code and link. Never creates an account, and answers `success: true` for an address with no account. |
105
+ | [`magicLinkVerify`](/reference/management-api/schema/auth#magiclinkverify) | Mutation | Verifies the six-digit code from a sign-in or confirmation email and creates a session. |
106
+ | [`mcpServer`](/reference/management-api/schema/mcp-server#mcpserver) | Query | Reads an MCP server. Null when no server has the ID. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
107
+ | [`mcpServerAuthHeaderClear`](/reference/management-api/schema/mcp-server#mcpserverauthheaderclear) | Mutation | Removes an MCP server's auth header. Succeeds when the server has none. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
108
+ | [`mcpServerAuthHeaderSet`](/reference/management-api/schema/mcp-server#mcpserverauthheaderset) | Mutation | Sets or replaces the auth header sent to an MCP server. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
109
+ | [`mcpServerDelete`](/reference/management-api/schema/mcp-server#mcpserverdelete) | Mutation | Deletes an MCP server with its stored URL and auth header. Cannot be undone; an unknown ID returns `NOT_FOUND`. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
110
+ | [`mcpServerRegister`](/reference/management-api/schema/mcp-server#mcpserverregister) | Mutation | Registers a third-party MCP server to a project. Scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
111
+ | [`mcpServerUpdate`](/reference/management-api/schema/mcp-server#mcpserverupdate) | Mutation | Renames an MCP server. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
112
+ | [`mcpServerUrlSet`](/reference/management-api/schema/mcp-server#mcpserverurlset) | Mutation | Replaces an MCP server's URL. The result shows only `urlDisplay`. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
113
+ | [`mfaChallengeCreate`](/reference/management-api/schema/auth#mfachallengecreate) | Mutation | Opens a challenge against one of the caller's factors. |
114
+ | [`mfaChallengeVerify`](/reference/management-api/schema/auth#mfachallengeverify) | Mutation | Verifies an authenticator code against a challenge and returns the caller's session at `AAL2`. The user's other sessions keep their level. A wrong code returns `MFA_CHALLENGE_FAILED`, and an expired challenge `TOKEN_EXPIRED`. |
115
+ | [`mfaFactorEnroll`](/reference/management-api/schema/auth#mfafactorenroll) | Mutation | Enrols an authenticator app for the caller and returns its secret, once. First deletes the caller's unverified factors, except the two newest enrolled in the last minute; one holding the given `friendlyName` is deleted however new. |
116
+ | [`mfaFactorUnenroll`](/reference/management-api/schema/auth#mfafactorunenroll) | Mutation | Removes one of the caller's factors. Removing a verified factor needs an `AAL2` session, and otherwise returns `MFA_REQUIRED`. A user the MFA policy requires cannot remove their last verified factor (`VALIDATION_ERROR`). |
117
+ | [`oauthAuthorize`](/reference/management-api/schema/auth#oauthauthorize) | Mutation | Creates the provider URL that starts a sign-in with an OAuth provider. |
118
+ | [`oauthCallback`](/reference/management-api/schema/auth#oauthcallback) | Mutation | Exchanges the authorisation code from an OAuth provider's redirect for a session. |
119
+ | [`oauthConsentApprove`](/reference/management-api/schema/auth#oauthconsentapprove) | Mutation | Approves an OAuth authorisation request for the signed-in user. |
120
+ | [`oauthConsentDeny`](/reference/management-api/schema/auth#oauthconsentdeny) | Mutation | Denies an OAuth authorisation request for the signed-in user. |
121
+ | [`oauthConsentDetails`](/reference/management-api/schema/auth#oauthconsentdetails) | Query | Reads an OAuth authorisation request waiting for the signed-in user's consent. Reading a request the user already consented to approves it. |
122
+ | [`organization`](/reference/management-api/schema/organization#organization) | Query | Reads an organisation by ID or slug. Null when no organisation matches. Scope: `ORGANIZATION_READ`. |
123
+ | [`organizationClientManagerScopesUpdate`](/reference/management-api/schema/organization#organizationclientmanagerscopesupdate) | Mutation | Sets the scopes a client manager holds in one organisation. The caller cannot edit their own scopes, and a client manager can add or remove only scopes they hold there themselves. Scope: `STAFF_INVITE_CLIENT_MANAGER`. |
124
+ | [`organizationCreate`](/reference/management-api/schema/organization#organizationcreate) | Mutation | Creates an organisation owned by the calling user. Scope: `ORGANIZATION_CREATE`. |
125
+ | [`organizationDelete`](/reference/management-api/schema/organization#organizationdelete) | Mutation | Deletes an organisation. Scope: `ORGANIZATION_DELETE`. |
126
+ | [`organizationInvitationAccept`](/reference/management-api/schema/organization#organizationinvitationaccept) | Mutation | Accepts an invitation, making the calling user a member with the scopes it carries. The invitation is used up. An unknown or expired token, or an existing membership, fails. |
127
+ | [`organizationInvitationDecline`](/reference/management-api/schema/organization#organizationinvitationdecline) | Mutation | Declines an invitation addressed to the calling user's email address and deletes it. |
128
+ | [`organizationInvitationRevoke`](/reference/management-api/schema/organization#organizationinvitationrevoke) | Mutation | Revokes a pending invitation, so its token stops working. Scope: `ORGANIZATION_INVITATIONS_DELETE`. |
129
+ | [`organizationMemberInvite`](/reference/management-api/schema/organization#organizationmemberinvite) | Mutation | Invites an email address to an organisation and emails the invitee. `delivery` says which email went out. Scope: `ORGANIZATION_INVITATIONS_CREATE`. |
130
+ | [`organizationMemberRemove`](/reference/management-api/schema/organization#organizationmemberremove) | Mutation | Removes a member from an organisation, with every scope they held there. The primary owner cannot be removed. Scope: `ORGANIZATION_MEMBERS_DELETE`. |
131
+ | [`organizationMemberScopesUpdate`](/reference/management-api/schema/organization#organizationmemberscopesupdate) | Mutation | Sets the scopes a member holds in an organisation. The caller cannot edit their own scopes, grant a scope they do not hold, or take `ORGANIZATION_MEMBERS_MANAGE_SCOPES` from the primary owner. Scope: `ORGANIZATION_MEMBERS_MANAGE_SCOPES`. |
132
+ | [`organizations`](/reference/management-api/schema/organization#organizations) | Query | Lists the organisations the user belongs to. `search` matches a case-insensitive substring of the name. Empty for an API key. |
133
+ | [`organizationShopifyWebhooks`](/reference/management-api/schema/shopify#organizationshopifywebhooks) | Query | Lists an organisation's Shopify webhooks. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
134
+ | [`organizationUpdate`](/reference/management-api/schema/organization#organizationupdate) | Mutation | Updates an organisation. Scope: `ORGANIZATION_UPDATE`. |
135
+ | [`passwordResetSend`](/reference/management-api/schema/auth#passwordresetsend) | Mutation | Sends a password-reset email. Returns `RATE_LIMITED` when the address was emailed within the minimum send interval or the project's email quota is spent. |
136
+ | [`passwordUpdate`](/reference/management-api/schema/auth#passwordupdate) | Mutation | Sets the signed-in user's password without asking for the current one. Ends the user's other sessions and keeps the caller's. An `AAL1` session may set a password only while the user holds no verified factor, and otherwise gets `MFA_REQUIRED`. |
137
+ | [`pickedqlQuery`](/reference/management-api/schema/analytics#pickedqlquery) | Query | Runs a PickedQL query against one project's analytics data. A statement that does not parse, or queries a project's data without a `project_id` filter, fails with `VALIDATION_ERROR`. Scope: `ORGANIZATION_REPORTS_READ`. |
138
+ | [`ping`](/reference/management-api/schema/common#ping) | Query | Checks that the API is up. Answers `pong`. |
139
+ | [`project`](/reference/management-api/schema/project#project) | Query | Reads a project. Null when no project has the ID. Scope: `ORGANIZATION_PROJECTS_READ`. |
140
+ | [`projectCreate`](/reference/management-api/schema/project#projectcreate) | Mutation | Creates a project, with a draft workspace named `Default`. Scope: `ORGANIZATION_PROJECTS_CREATE`. |
141
+ | [`projectDelete`](/reference/management-api/schema/project#projectdelete) | Mutation | Deletes a project. Scope: `ORGANIZATION_PROJECTS_DELETE`. |
142
+ | [`projectPreviewEnvironmentCreate`](/reference/management-api/schema/project#projectpreviewenvironmentcreate) | Mutation | Creates a preview environment on a project. Invalid input comes back as `userErrors`. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
143
+ | [`projectPreviewEnvironmentDelete`](/reference/management-api/schema/project#projectpreviewenvironmentdelete) | Mutation | Deletes a preview environment. An unknown ID comes back as `userErrors`. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
144
+ | [`projectPreviewEnvironmentUpdate`](/reference/management-api/schema/project#projectpreviewenvironmentupdate) | Mutation | Updates a preview environment. Invalid input comes back as `userErrors`. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
145
+ | [`projects`](/reference/management-api/schema/project#projects) | Query | Lists the projects the user can reach, across every organisation they belong to. `search` matches a case-insensitive substring of the name. Empty for an API key. |
146
+ | [`projectShopifyMetafieldConfigs`](/reference/management-api/schema/shopify#projectshopifymetafieldconfigs) | Query | Lists a project's Shopify metafield configs. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
147
+ | [`projectUpdate`](/reference/management-api/schema/project#projectupdate) | Mutation | Updates a project's name or brief. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
148
+ | [`report`](/reference/management-api/schema/report#report) | Query | Reads a project report. Null when no project report has the ID. Scope: `ORGANIZATION_REPORTS_READ`. |
149
+ | [`reportCreate`](/reference/management-api/schema/report#reportcreate) | Mutation | Creates a report and adds it to a project. Scope: `ORGANIZATION_REPORTS_CREATE`. |
150
+ | [`reportDelete`](/reference/management-api/schema/report#reportdelete) | Mutation | Deletes a report from its project, and the report itself when no other project uses it. Scope: `ORGANIZATION_REPORTS_DELETE`. |
151
+ | [`reportUpdate`](/reference/management-api/schema/report#reportupdate) | Mutation | Updates a project report and its report. Scope: `ORGANIZATION_REPORTS_UPDATE`. |
152
+ | [`savedView`](/reference/management-api/schema/saved-view#savedview) | Query | Reads a saved view. Scope: `ORGANIZATION_PROJECTS_READ`. |
153
+ | [`savedViewCreate`](/reference/management-api/schema/saved-view#savedviewcreate) | Mutation | Creates a saved view of a list in a project. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
154
+ | [`savedViewDelete`](/reference/management-api/schema/saved-view#savedviewdelete) | Mutation | Deletes a saved view. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
155
+ | [`savedViewUpdate`](/reference/management-api/schema/saved-view#savedviewupdate) | Mutation | Updates a saved view: its name, its controls, or whether it is the default. Scope: `ORGANIZATION_PROJECTS_UPDATE`. |
156
+ | [`sessionCreate`](/reference/management-api/schema/auth#sessioncreate) | Mutation | Signs in with an email address and password and returns an `AAL1` session. |
157
+ | [`sessionRefresh`](/reference/management-api/schema/auth#sessionrefresh) | Mutation | Exchanges a refresh token for a new session. |
158
+ | [`sessionStart`](/reference/management-api/schema/auth#sessionstart) | Mutation | Begins a sign-in from an email address alone: answers `PASSWORD`, or emails a sign-in code and answers `EMAIL_CODE`. Never creates an account. Returns `RATE_LIMITED` past 10 requests a minute from one IP address, or when the project's email quota is spent. |
159
+ | [`shopifyCollectionContentUpdate`](/reference/management-api/schema/shopify#shopifycollectioncontentupdate) | Mutation | Updates the content at `key` of a Shopify collection, stored in its app metafield `content.<key>`. Keeps up to nine earlier values. The shop must belong to the calling API key's organisation. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
160
+ | [`shopifyMetafieldConfigCreate`](/reference/management-api/schema/shopify#shopifymetafieldconfigcreate) | Mutation | Creates a Shopify metafield config for a project. Scope: `ORGANIZATION_INTEGRATIONS_CREATE`. |
161
+ | [`shopifyMetafieldConfigDelete`](/reference/management-api/schema/shopify#shopifymetafieldconfigdelete) | Mutation | Deletes a Shopify metafield config. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
162
+ | [`shopifyMetafieldConfigs`](/reference/management-api/schema/shopify#shopifymetafieldconfigs) | Query | Lists a project's Shopify metafield configs. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
163
+ | [`shopifyMetafieldConfigUpdate`](/reference/management-api/schema/shopify#shopifymetafieldconfigupdate) | Mutation | Updates a Shopify metafield config. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
164
+ | [`shopifyProduct`](/reference/management-api/schema/shopify#shopifyproduct) | Query | Reads a Shopify product. Always returns null. |
165
+ | [`shopifyProductContentUpdate`](/reference/management-api/schema/shopify#shopifyproductcontentupdate) | Mutation | Updates the content at `key` of a Shopify product, stored in its app metafield `content.<key>`. Keeps up to nine earlier values. The shop must belong to the calling API key's organisation. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
166
+ | [`shopifyProducts`](/reference/management-api/schema/shopify#shopifyproducts) | Query | Lists Shopify products. Always returns an empty page. |
167
+ | [`shopifyWebhookCreate`](/reference/management-api/schema/shopify#shopifywebhookcreate) | Mutation | Creates a Shopify webhook for a project and generates its HMAC secret. The result is the only place the secret appears. Scope: `ORGANIZATION_INTEGRATIONS_CREATE` and `ORGANIZATION_INTEGRATIONS_READ`. |
168
+ | [`shopifyWebhookDelete`](/reference/management-api/schema/shopify#shopifywebhookdelete) | Mutation | Deletes a Shopify webhook. Scope: `ORGANIZATION_INTEGRATIONS_DELETE`. |
169
+ | [`shopifyWebhooks`](/reference/management-api/schema/shopify#shopifywebhooks) | Query | Lists an organisation's Shopify webhooks. Scope: `ORGANIZATION_INTEGRATIONS_READ`. |
170
+ | [`shopifyWebhookUpdate`](/reference/management-api/schema/shopify#shopifywebhookupdate) | Mutation | Updates a Shopify webhook. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
171
+ | [`step`](/reference/management-api/schema/step#step) | Query | Reads a step. Scope: `ORGANIZATION_WORKSPACE_READ`. |
172
+ | [`stepCreate`](/reference/management-api/schema/step#stepcreate) | Mutation | Creates a step in a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
173
+ | [`stepDelete`](/reference/management-api/schema/step#stepdelete) | Mutation | Deletes a step. A step that an experience references is not deleted, and comes back as an `IN_USE` user error. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
174
+ | [`steps`](/reference/management-api/schema/step#steps) | Query | Lists the steps in a workspace. `search` matches a case-insensitive substring of the name; `sortKey` and `reverse` set the order. Scope: `ORGANIZATION_WORKSPACE_READ`. |
175
+ | [`stepUpdate`](/reference/management-api/schema/step#stepupdate) | Mutation | Updates a step. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
176
+ | [`tenant`](/reference/management-api/schema/tenant-branding#tenant) | Query | Reads a tenant and its branding by slug or hostname. Returns the default tenant when neither matches. Needs no authentication, and responses are cacheable for 5 minutes. |
177
+ | [`updateShopifyCollectionContent`](/reference/management-api/schema/shopify#updateshopifycollectioncontent) | Mutation | Updates the content at `key` of a Shopify collection, stored in its app metafield `content.<key>`. Keeps up to nine earlier values. The shop must belong to the calling API key's organisation. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
178
+ | [`updateShopifyMetafieldConfig`](/reference/management-api/schema/shopify#updateshopifymetafieldconfig) | Mutation | Updates a Shopify metafield config. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
179
+ | [`updateShopifyProductContent`](/reference/management-api/schema/shopify#updateshopifyproductcontent) | Mutation | Updates the content at `key` of a Shopify product, stored in its app metafield `content.<key>`. Keeps up to nine earlier values. The shop must belong to the calling API key's organisation. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
180
+ | [`updateShopifyWebhook`](/reference/management-api/schema/shopify#updateshopifywebhook) | Mutation | Updates a Shopify webhook. Scope: `ORGANIZATION_INTEGRATIONS_UPDATE`. |
181
+ | [`user`](/reference/management-api/schema/auth#user) | Query | Reads the signed-in user. Null when the caller is an API key or the auth service rejects the token. Exempt from the MFA policy, so a user the policy gates can read `mfa` and `mfaFactors`. |
182
+ | [`viewerScopes`](/reference/management-api/schema/auth#viewerscopes) | Query | Lists the scopes the caller holds outside any organisation, such as `ORGANIZATION_CREATE`. Empty for an API key. `Organization.viewerScopes` lists the scopes held in one organisation. |
183
+ | [`workbenchAssetAdoptOwned`](/reference/management-api/schema/workbench#workbenchassetadoptowned) | Mutation | Moves the ownership of an asset-library asset to a workbench, as `OWNED`. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
184
+ | [`workbenchAssetImport`](/reference/management-api/schema/workbench#workbenchassetimport) | Mutation | Imports an asset owned elsewhere into a workbench as `IMPORTED`. The asset's owner does not change. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
185
+ | [`workbenchAssetRemove`](/reference/management-api/schema/workbench#workbenchassetremove) | Mutation | Removes an asset from a workbench. Removing an `OWNED` asset also deletes it, which needs `ORGANIZATION_PROJECTS_UPDATE` and fails once a publish uses the asset. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
186
+ | [`workflow`](/reference/management-api/schema/workflow#workflow) | Query | Reads a workflow. Scope: `ORGANIZATION_WORKSPACE_READ`. |
187
+ | [`workflowCreate`](/reference/management-api/schema/workflow#workflowcreate) | Mutation | Creates a workflow in a workspace. The caller must hold the scopes the tools of the graph need, as `Workflow.scopes` describes. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
188
+ | [`workflowDelete`](/reference/management-api/schema/workflow#workflowdelete) | Mutation | Deletes a workflow. Published versions keep their copy, and an action that started it can start another workflow. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
189
+ | [`workflowGraphUpdate`](/reference/management-api/schema/workflow#workflowgraphupdate) | Mutation | Updates the graph of a workflow with a change set, all or nothing. A refused change set writes nothing and comes back in `errors`. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
190
+ | [`workflowRun`](/reference/management-api/schema/workflow-run#workflowrun) | Query | Reads a workflow run. Scope: `ORGANIZATION_PROJECTS_READ`. |
191
+ | [`workflows`](/reference/management-api/schema/workflow#workflows) | Query | Lists the workflows in a workspace. `search` matches a case-insensitive substring of the name. Scope: `ORGANIZATION_WORKSPACE_READ`. |
192
+ | [`workflowTestRun`](/reference/management-api/schema/workflow#workflowtestrun) | Mutation | Tests a workflow by walking its draft graph once, holding back every write. Nothing is stored, and the caller must also hold every scope in `Workflow.scopes`. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
193
+ | [`workflowTools`](/reference/management-api/schema/workflow#workflowtools) | Query | Lists every tool a workflow node can run, with the arguments each takes. |
194
+ | [`workflowUpdate`](/reference/management-api/schema/workflow#workflowupdate) | Mutation | Updates the name or the node visit limit of a workflow. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
195
+ | [`workspace`](/reference/management-api/schema/workspace#workspace) | Query | Reads a workspace. Scope: `ORGANIZATION_WORKSPACE_READ`. |
196
+ | [`workspaceArchive`](/reference/management-api/schema/workspace#workspacearchive) | Mutation | Archives a workspace, which moves it out of the default list. It stays editable. Archiving an archived workspace changes nothing. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
197
+ | [`workspaceContentEntryValidation`](/reference/management-api/schema/cms-models#workspacecontententryvalidation) | Query | Verifies each content entry in a workspace against its model's schema, including embedded blocks. It changes no data. Scope: `ORGANIZATION_WORKSPACE_READ`. |
198
+ | [`workspaceCreate`](/reference/management-api/schema/workspace#workspacecreate) | Mutation | Creates an empty draft workspace in a project. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
199
+ | [`workspaceDelete`](/reference/management-api/schema/workspace#workspacedelete) | Mutation | Deletes a workspace that is not live. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
200
+ | [`workspaceDiff`](/reference/management-api/schema/workspace-version#workspacediff) | Query | Compares two workspace snapshots and lists the entities added, removed and modified. Each side is a workspace at its current content or a published version, and both sides must belong to one project. Scope: `ORGANIZATION_WORKSPACE_READ`. |
201
+ | [`workspaceDuplicate`](/reference/management-api/schema/workspace#workspaceduplicate) | Mutation | Copies a workspace and every entity in it, workflows included, into a new draft workspace in the same project. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
202
+ | [`workspaceExport`](/reference/management-api/schema/workspace#workspaceexport) | Query | Exports a workspace and every entity in it as a JSON bundle that `workspaceImport` reads. The bundle lists the asset versions its content references; download each file from its `downloadUrl`. Scope: `ORGANIZATION_WORKSPACE_READ`. |
203
+ | [`workspaceImport`](/reference/management-api/schema/workspace#workspaceimport) | Mutation | Creates a draft workspace in a project from a bundle that `workspaceExport` returned. Every entity gets a new ID, and every reference between entities, assets through `assetMap` included, points at the new IDs. Nothing is created when a `userError` is returned. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
204
+ | [`workspacePublish`](/reference/management-api/schema/workspace#workspacepublish) | Mutation | Publishes a workspace: makes an immutable version of it and serves that version to visitors. The workspace becomes `LIVE`, and an archived workspace returns to the default list. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
205
+ | [`workspaceUnarchive`](/reference/management-api/schema/workspace#workspaceunarchive) | Mutation | Unarchives a workspace, which returns it to `DRAFT`. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
206
+ | [`workspaceUpdate`](/reference/management-api/schema/workspace#workspaceupdate) | Mutation | Renames a workspace. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
207
+ | [`workspaceVersionPublish`](/reference/management-api/schema/workspace#workspaceversionpublish) | Mutation | Makes a published version the version its project serves. No new version is made and the workspace's draft does not change; the workspace becomes `LIVE`, and an archived one returns to the default list. Scope: `ORGANIZATION_WORKSPACE_UPDATE`. |
208
208
 
209
209
  ## Domains
210
210