All endpoints — API Reference

Every endpoint in the Synerise REST API.

667 endpoints across 64 tags.

Activities

• GET /activities-api/activities/{clientId} — Get profile activities (deprecated)
• POST /activities-api/activity/by/{identifierType} — Get a single activity (deprecated)
• GET /activities-api/descriptions — Get description mappings
• POST /activities-api/descriptions — Add description mapping
• POST /activities-api/descriptions/{descriptionId} — Update description mapping
• GET /activities-api/labels — Get label mappings
• POST /activities-api/labels — Add label mapping
• POST /activities-api/labels/{labelId} — Update label mapping
• GET /activities-api/icons — Get icon mappings
• POST /activities-api/icons — Add icon mapping
• POST /activities-api/icons/{iconID} — Update icon mapping
• GET /activities-api/events — Get profile's own events
• POST /activities-api/events/by/{identifierType} — Get profile events as a workspace/Synerise user

Time Optimizer

• POST /activity-time-estimator/v1/query-model — Generate activity time predictions

Search Stats

• GET /search/v2/indices/{indexId}/stats/queries/summary — Get queries stats summary
• GET /search/v2/indices/{indexId}/stats/queries/top — Get top query statistics
• GET /search/v2/indices/{indexId}/stats/filters/summary — Get filters stats
• GET /search/v2/indices/{indexId}/stats/rules/summary — Get rules stats
• GET /search/v2/indices/stats/queries/summary — Get queries summary for multiple indices

Recommendation statistics

• POST /recommendations/v2/campaigns/stats — Get recommendation campaign statistics
• GET /recommendations/v2/campaigns/stats/global — Get global recommendation campaign statistics
• GET /recommendations/v2/campaigns/{campaignId}/stats — Get recommendation campaign statistics
• GET /recommendations/v2/campaigns/{campaignId}/products/stats — Get statistics for top items in a campaign

Analytics: Management

• POST /analytics/analytics/batch-delete — Delete multiple analyses
• GET /analytics/directories — List directories
• POST /analytics/directories — Create directory
• PATCH /analytics/directories/{directoryId} — Rename directory
• DELETE /analytics/directories/{directoryId} — Delete directory
• PATCH /analytics/directories/change/{analyticId} — Change Directory

Analytics: Metrics

• GET /analytics/{namespace}/metrics — List metrics
• POST /analytics/{namespace}/metrics — Create metric analysis
• GET /analytics/{namespace}/metrics/{metricId} — Get metric details
• PUT /analytics/{namespace}/metrics/{metricId} — Update metric
• DELETE /analytics/{namespace}/metrics/{metricId} — Delete metric analysis
• POST /analytics/analytics/v3/metrics/preview — Preview metric
• POST /analytics/analytics/v3/metrics/{metricId}/recalculate/override — Calculate metric with parameter override
• POST /analytics/analytics/v3/metrics/{metricId}/recalculate — Calculate metric
• POST /analytics/analytics/v3/metrics/{metricId}/dynamic/value — Calculate dynamic metric
• GET /analytics/analytics/v3/metrics/histogram-metrics — Get metrics usable in histograms

Analytics: Reports

• POST /analytics/analytics/v4/reports/{reportId}/recalculate/override — Calculate report with override
• POST /analytics/analytics/v4/reports/{reportId}/recalculate — Recalculate report
• POST /analytics/analytics/v4/reports/preview — Preview report
• POST /analytics/analytics/v4/reports/preview-csv — Preview report as CSV
• GET /analytics/{namespace}/reports — List reports
• POST /analytics/{namespace}/reports — Create report analysis
• GET /analytics/{namespace}/reports/{reportId} — Get report analysis details
• PUT /analytics/{namespace}/reports/{reportId} — Update report analysis
• DELETE /analytics/{namespace}/reports/{reportId} — Delete report analysis

Analytics: Expressions

• POST /analytics/{namespace}/expressions/visible-for-client/by/{identifierType} — Get expressions for profile card
• POST /analytics/{namespace}/expressions/{expressionId}/calculate/by/{identifierType} — Calculate expression for profile
• GET /analytics/{namespace}/expressions — List expressions
• POST /analytics/{namespace}/expressions — Create expression
• GET /analytics/{namespace}/expressions/{expressionId} — Get expression details
• PUT /analytics/{namespace}/expressions/{expressionId} — Update expression
• DELETE /analytics/{namespace}/expressions/{expressionId} — Delete expression
• POST /analytics/{namespace}/expressions/preview/by/{identifierType} — Get expression preview

Analytics: Histograms

• GET /analytics/{namespace}/histograms — List histograms
• POST /analytics/{namespace}/histograms — Create histogram
• GET /analytics/{namespace}/histograms/{histogramId} — Get histogram details
• PUT /analytics/{namespace}/histograms/{histogramId} — Update histogram analysis
• DELETE /analytics/{namespace}/histograms/{histogramId} — Delete histogram
• POST /analytics/analytics/v2/metrics/histograms/{histogramId}/recalculate/override — Calculate histogram with parameter override
• POST /analytics/analytics/v2/metrics/histograms/preview — Preview histogram

Analytics: Segmentations

• POST /analytics/analytics/v2/segmentations/{segmentationId}/dynamic/value — Calculate dynamic segmentation
• POST /analytics/analytics/v2/segmentations/preview — Preview segmentation
• POST /analytics/analytics/v2/segmentations/preview/clients — Preview profiles in segmentation
• POST /analytics/profiles/segmentations/firstMatch/by/{identifierType} — Get first matching segmentation for profile from provided list
• GET /analytics/{namespace}/segmentations — List segmentations
• POST /analytics/{namespace}/segmentations — Create segmentation
• GET /analytics/{namespace}/segmentations/{segmentationId} — Get segmentation details
• PUT /analytics/{namespace}/segmentations/{segmentationId} — Update segmentation
• DELETE /analytics/{namespace}/segmentations/{segmentationId} — Delete segmentation
• POST /analytics/{namespace}/segmentations/visible-for-client/by/{identifierType} — Get segmentations for profile card
• POST /analytics/{namespace}/segmentations/check/by/{identifierType} — Check if profile in segmentations

Analytics: Aggregates

• POST /analytics/analytics/definitions-manager/aggregates/{aggregateId}/client/{clientId}/calculate/histogram — Calculate aggregate for profile with period conditions
• POST /analytics/{namespace}/aggregates/preview/by/{identifierType} — Get aggregate preview
• POST /analytics/{namespace}/aggregates/visible-for-client/by/{identifierType} — Get aggregates for profile card
• POST /analytics/{namespace}/aggregates/{aggregateId}/calculate/by/{identifierType} — Calculate aggregate for profile
• GET /analytics/{namespace}/aggregates — List aggregates
• POST /analytics/{namespace}/aggregates — Create aggregate
• GET /analytics/{namespace}/aggregates/{aggregateId} — Get aggregate details
• PUT /analytics/{namespace}/aggregates/{aggregateId} — Update aggregate
• DELETE /analytics/{namespace}/aggregates/{aggregateId} — Delete aggregate

Analytics: Sankeys

• POST /analytics/analytics/v2/sankeys/preview — Preview Sankey analysis
• GET /analytics/{namespace}/sankeys — List Sankeys
• POST /analytics/{namespace}/sankeys — Create Sankey analysis
• GET /analytics/{namespace}/sankeys/{sankeyId} — Get Sankey details
• PUT /analytics/{namespace}/sankeys/{sankeyId} — Update Sankey
• DELETE /analytics/{namespace}/sankeys/{sankeyId} — Delete Sankey

Analytics: Funnels

• POST /analytics/analytics/v2/funnels/preview — Preview funnel calculation
• POST /analytics/analytics/v2/funnels/{funnelId}/recalculate/override — Recalculate funnel with parameter override
• GET /analytics/{namespace}/funnels — List funnels
• POST /analytics/{namespace}/funnels — Create a funnel
• GET /analytics/{namespace}/funnels/{funnelId} — Get funnel details
• PUT /analytics/{namespace}/funnels/{funnelId} — Update funnel
• DELETE /analytics/{namespace}/funnels/{funnelId} — Delete funnel

Analytics: Trends

• GET /analytics/{namespace}/trends — List trends
• POST /analytics/{namespace}/trends — Create a trend
• GET /analytics/{namespace}/trends/{trendId} — Get trend details
• PUT /analytics/{namespace}/trends/{trendId} — Update trend
• DELETE /analytics/{namespace}/trends/{trendId} — Delete trend
• POST /analytics/analytics/v2/trends/{trendId}/recalculate/override — Calculate trend with parameter override
• POST /analytics/analytics/v2/trends/preview — Preview trend calculation

Events

• POST /v4/transactions — Create a transaction
• POST /v4/transactions/batch — Batch add or update transactions
• GET /v4/events/by-client/{clientId} — Get Profile events as Workspace (deprecated)
• GET /v4/events — Get Profile's own events (deprecated)
• POST /v4/events/application-started — Application started
• POST /v4/events/registered — Profile account registered
• POST /v4/events/logged-in — Profile logged in
• POST /v4/events/logged-out — Profile logged out
• POST /v4/events/added-to-cart — Item added to cart
• POST /v4/events/removed-from-cart — Item removed from cart
• POST /v4/events/added-to-favorites — Product added to favorites
• POST /v4/events/product-view — Item viewed
• POST /v4/events/assigned-to-company — Profile assigned to company
• POST /v4/events/appeared-in-location — Profile logged location
• POST /v4/events/push/received — Push notification received
• POST /v4/events/push/viewed — Push notification viewed
• POST /v4/events/push/clicked — Push notification clicked
• POST /v4/events/push/cancelled — Push notifications cancelled
• POST /v4/events/cancelled-transaction — Transaction cancelled
• POST /v4/events/hit-timer — Timer hit
• POST /v4/events/searched — Search requested
• POST /v4/events/shared — Content shared
• POST /v4/events/recommendation-seen — Recommendation viewed (deprecated)
• POST /v4/events/recommendation-click — Recommendation clicked (deprecated)
• POST /v4/events/visited-screen — Mobile app screen visited
• POST /v4/events/custom — Custom event
• POST /v4/events/batch — Batch send events
• GET /v4/server/time — Get server time
• POST /v4/events/recommendation-view — Recommendation viewed
• POST /v4/events/item-search-click — Search result clicked

Profile management

• POST /v4/clients — Create or update a Profile
• POST /v4/clients/merge/from/custom-ids/{sourceCustomIDs}/to/custom-id/{targetCustomID} — Merge profiles by customId
• POST /v4/clients/merge/from/ids/{fromClientIds}/to/id/{toClientId} — Merge profiles by clientId
• POST /v4/clients/batch — Batch add or update profiles
• GET /v4/clients/{clientId} — Get profile data
• POST /v4/clients/{clientId} — Update a profile (identify by ID)
• DELETE /v4/clients/{clientId} — Delete a profile
• POST /v4/clients/by-email/{clientEmail} — Update a profile (identify by email)
• POST /v4/clients/by-customid/{customId} — Update a profile (identify by customId)
• DELETE /v4/clients/by-custom-id/{customId} — Delete a profile (identify by customId)
• GET /v4/clients/{identifierType}/{identifierValue} — Fetch profile data
• GET /v4/clients/batch/by-phone/{phoneNumber} — Batch fetch profiles by phone number
• GET /crm/v1/clients/{clientId}/contacts — Get Profile details (deprecated)
• PUT /crm/v1/contacts/{clientId} — Update Profile (deprecated)
• POST /morph/exports/clients/segmentation — Create and run profile export
• GET /morph/exports/clients/{taskId}/status — Check profile export status
• GET /morph/exports/clients/{taskId}/data — Get exported profiles
• GET /notes-service/by-id/{clientId} — Get all Profile notes
• POST /notes-service/by-id/{clientId} — Create a note
• GET /notes-service/by-id/{clientId}/{noteId} — Get note
• PUT /notes-service/by-id/{clientId}/{noteId} — Update note
• DELETE /notes-service/by-id/{clientId}/{noteId} — Delete note
• POST /sauth/management/client/{clientID}/logout — Log out a Profile

Tags

• GET /v4/clients/tags — Get all tags
• POST /v4/tags — Create a tag
• PUT /v4/tags/{tagID} — Update a tag
• DELETE /v4/tags/{tagID} — Remove a tag
• GET /v4/clients/{clientId}/tags — Get profile tags
• POST /v4/clients/{clientId}/tags/{tagID} — Assign tag to profile
• DELETE /v4/clients/{clientId}/tags/{tagID} — Remove tag from profile

Profile devices

• POST /v4/clients/{clientId}/linked-devices — Link a device by profile ID
• POST /v4/clients/{identifierType}/{identifierValue}/linked-devices — Link a device by other parameters
• POST /v4/my-account/linked-devices — Link a device to currently logged in profile
• POST /push-devices/web-push/clean-up/{clientId} — Clean up web push tokens
• POST /push-devices/mobile-push-subscriber/clean-up/{clientId} — Clean up mobile push tokens
• POST /push-devices/clients/by-uuid/{identifierValue}/linked-devices — Link a device by other parameters
• POST /push-devices/clients/linked-devices — Link a device by other parameters

Profile account management

• GET /v4/my-account/personal-information — Get Profile's own data
• POST /v4/my-account/personal-information — Update Profile's own data
• POST /v4/my-account/phone-update/request — Request profile phone number change
• POST /v4/my-account/phone-update/confirmation — Confirm profile phone number change
• POST /sauth/clients/password-reset/request — Request Profile password reset
• POST /sauth/clients/password-reset/confirmation — Confirm Profile password reset
• POST /sauth/my-account/change-password — Change Profile password
• POST /sauth/v2/my-account/delete — Delete account
• POST /sauth/v2/my-account/email-change/request — Request Profile email change
• POST /sauth/v3/my-account/logout — Log out a Profile
• POST /sauth/my-account/email-change/confirmation — Confirm Profile email change
• POST /sauth/clients/facebook/email-change/request — Change Facebook Profile email
• POST /sauth/clients/oauth/deleted — Delete Client Account (OAuth) (deprecated)
• POST /sauth/clients/apple/deleted — Delete Profile account (Sign in with Apple) (deprecated)
• POST /sauth/clients/facebook/deleted — Delete Facebook Profile Account (deprecated)
• POST /sauth/my-account/delete — Delete account (deprecated)
• POST /sauth/my-account/email-change/request — Request Profile email change (deprecated)

Authorization (deprecated)

• GET /v4/auth/refresh/profile — Refresh a Workspace token (deprecated)
• POST /v4/auth/login/profile — Log in as Workspace (deprecated)
• POST /sauth/auth/login/client — Authenticate as Profile (deprecated)
• POST /sauth/auth/login/client/anonymous — Authenticate anonymously (deprecated)
• POST /sauth/auth/login/client/facebook — Authenticate with Facebook (deprecated)
• POST /sauth/auth/login/client/facebook/no-registration — Authenticate with Facebook without registration (deprecated)
• POST /sauth/auth/login/client/oauth — Authenticate with OAuth (deprecated)
• POST /sauth/auth/login/client/oauth/no-registration — Authenticate with OAuth without registration (deprecated)
• POST /sauth/auth/login/client/apple — Authenticate with Sign in with Apple (deprecated)
• POST /sauth/auth/login/client/apple/no-registration — Authenticate with Sign in with Apple without registration (deprecated)
• GET /sauth/auth/refresh/client — Refresh a Profile token (deprecated)
• POST /sauth/v2/auth/refresh/client — Refresh a Profile token (deprecated)
• POST /sauth/v2/auth/login/client — Authenticate as Profile (deprecated)
• POST /sauth/v2/auth/login/client/conditional — Authenticate as Profile (conditional) (deprecated)
• POST /sauth/v2/auth/login/client/anonymous — Authenticate anonymously (deprecated)
• POST /sauth/v2/auth/server/login/client — Authenticate as Profile (deprecated)

AI Events

• POST /v4/events/ai-compat/batch — Batch upload AI events
• POST /v4/events/ai-compat/item.search.click — Item clicked in search
• POST /v4/events/ai-compat/suggestion.search.click — Suggestion clicked in search
• POST /v4/events/ai-compat/product.search.click — Product clicked in search (deprecated)
• POST /v4/events/ai-compat/recommendation.click — Item clicked in recommendation
• POST /v4/events/ai-compat/recommendation.view — Recommendation viewed

Workflows

• GET /automation-brain/diagrams — Get list of workflows
• GET /automation-brain/v2/diagrams — Get list of workflows
• POST /automation-brain/diagrams/{diagramId}/run — Run/resume workflow
• POST /automation-brain/diagrams/{diagramId}/pause — Pause workflow
• POST /automation-brain/diagrams/{diagramId}/stop — Stop workflow
• POST /automation-brain/diagrams/{diagramId}/schedule-on — Enable schedule for workflow
• POST /automation-brain/diagrams/{diagramId}/schedule-off — Disable schedule for workflow
• GET /automation-brain/diagrams/{diagramId}/statistics — Get workflow statistics with node details
• GET /automation-brain/diagrams/{diagramId}/blocks/{blockId}/statistics — Get node statistics

Brickworks: Schemas

• GET /brickworks/v1/schemas — Get schemas
• POST /brickworks/v1/schemas — Create schema
• GET /brickworks/v1/schemas/{SchemaIdentifier} — Get schema
• PUT /brickworks/v1/schemas/{SchemaIdentifier} — Update schema
• DELETE /brickworks/v1/schemas/{SchemaIdentifier} — Delete schema

Brickworks: Records

• GET /brickworks/v1/schemas/{SchemaIdentifier}/records — Get records from schema
• POST /brickworks/v1/schemas/{SchemaIdentifier}/records — Add record to schema
• GET /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier} — Get record
• PUT /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier} — Update record
• DELETE /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier} — Delete record
• POST /brickworks/v1/schemas/records/preview/by/{IdentifierType} — Preview object (as workspace)
• POST /brickworks/v1/schemas/records/preview — Preview object (as any consumer)
• POST /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/duplicate — Duplicate record
• POST /brickworks/v1/async/schemas/{SchemaIdentifier}/records — Batch create or update records (async)
• PATCH /brickworks/v1/async/schemas/{SchemaIdentifier}/records — Batch create or partially update record (async)
• POST /brickworks/v1/async/schemas/{SchemaIdentifier}/record — Create or update record (async)
• PATCH /brickworks/v1/async/schemas/{SchemaIdentifier}/record — Create or partially update record (async)

Brickworks: Content generation

• POST /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/generate/by/{IdentifierType} — Generate object from a record (as workspace)
• POST /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/generate — Generate object from a record (as any consumer)

Brickworks: External sources

• GET /brickworks/v1/external-sources — List external sources
• POST /brickworks/v1/external-sources — Create external source
• GET /brickworks/v1/external-sources/{ExternalDataSourceId} — Get External Source
• PUT /brickworks/v1/external-sources/{ExternalDataSourceId} — Update External Source
• DELETE /brickworks/v1/external-sources/{ExternalDataSourceId} — Delete external source

Brickworks: Record versions

• GET /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/versions — Get record versions
• GET /brickworks/v1/schemas/{SchemaIdentifier}/records/{RecordIdentifier}/versions/{RecordVersionIdentifier} — Get record version

Consumption

• POST /business-profile-service/organizations/usage/stats/newDataPoints — Get consumption metric with new data points
• POST /business-profile-service/organizations/usage/stats/retentionDataPoints — Get consumption metric with retention data points

Organization workspaces

• GET /business-profile-service/business-profiles — Get universal list of organization workspaces
• GET /business-profile-service/organizations/workspaces — Get all workspaces from organization
• GET /business-profile-service/organizations/business-profiles/with-identifiers — Get universal list of organization workspaces with profile identifiers

Settings

• GET /business-profile-service/organizations/business-profiles — Get universal list of organization workspaces
• GET /sauth/settings/ban — Get ban settings
• POST /sauth/settings/ban — Update ban settings
• GET /sauth/settings/templates — Get email template settings
• POST /sauth/settings/templates — Update email template settings
• GET /sauth/settings/device-control — Get device authorization settings
• POST /sauth/settings/device-control — Update device authorization settings
• GET /sauth/settings/general — Get general settings
• POST /sauth/settings/general — Update general settings
• GET /sauth/settings/oauth — Get OAuth settings
• POST /sauth/settings/oauth — Update OAuth settings
• GET /sauth/settings/synerise-auth — getSyneriseAuthConfig
• POST /sauth/settings/synerise-auth — updateSyneriseAuthSettings
• GET /sauth/settings/oauth/facebook — getFacebookOauthSettings
• POST /sauth/settings/oauth/facebook — updateFacebookOauthSettings
• GET /sauth/settings/oauth/google — getGoogleOauthSettings
• POST /sauth/settings/oauth/google — updateGoogleOauthSettings
• GET /sauth/settings/oauth/apple — Get Sign in with Apple settings
• POST /sauth/settings/oauth/apple — Update Sign in with Apple settings
• POST /uauth/business-profile/mark-favorite — Add or remove business profile to favorites

Catalogs

• GET /catalogs/bags/{catalogId}/csv — Get all items as CSV file
• POST /catalogs/bags/{catalogId}/items/upload — Add items from CSV
• GET /catalogs/bags — Get catalogs
• POST /catalogs/bags — Add catalog
• DELETE /catalogs/bags — Delete catalogs
• GET /catalogs/bags/{catalogId}/keys — Get catalog keys
• GET /catalogs/bags/{catalogId} — Get catalog info
• DELETE /catalogs/bags/{catalogId} — Delete catalog
• GET /catalogs/bags/{catalogId}/items — Get items from catalog
• POST /catalogs/bags/{catalogId}/items — Add item
• POST /catalogs/bags/{catalogId}/items/batch — Batch add items
• PATCH /catalogs/bags/{catalogId}/enrichment/fields — Update enrichment fields
• GET /catalogs/bags/{catalogId}/items/itemKey/{itemKey} — Get single item by itemKey
• DELETE /catalogs/bags/{catalogId}/items/itemKey/{itemKey} — Delete single item by itemKey
• GET /catalogs/bags/{catalogId}/items/{itemId} — Get single item by database ID
• POST /catalogs/bags/{catalogId}/items/{itemId} — Update single item by database ID
• DELETE /catalogs/bags/{catalogId}/items/{itemId} — Delete single item by database ID
• GET /catalogs/items — Get all items
• POST /catalogs/bags/{catalogId}/mappings — Add mapping
• GET /catalogs/mappings — Get all mappings
• DELETE /catalogs/mappings/{bpActionParamKey} — Delete mapping
• GET /catalogs/itemDetail — Get single item by unique key
• DELETE /catalogs/v2/bags/{catalogId}/items — Delete all items from a catalog
• DELETE /catalogs/v2/bags/{catalogId}/items/batch — Delete items by itemKeys
• PATCH /catalogs/v2/bags/{catalogId}/enable/filtering — Enable filtering
• PATCH /catalogs/v2/bags/{catalogId}/disable/filtering — Disable filtering
• POST /catalogs/v1/async/bags/{catalogId}/item — Add or update item asynchronously
• PATCH /catalogs/v1/async/bags/{catalogId}/item — Add or update (partial) item asynchronously
• POST /catalogs/v1/async/bags/{catalogId}/items — Batch add or update items asynchronously
• PATCH /catalogs/v1/async/bags/{catalogId}/items — Batch add or update (partial) items asynchronously

Item filters

• POST /items/v2/filter/validate — Validate item filter

Visual Search

• GET /search/v2/indices/{indexId}/visual — Visual items search
• POST /search/v2/indices/{indexId}/visual — Visual items search
• GET /search/v2/indices/{indexId}/visual/explain — Explained visual items search
• POST /search/v2/indices/{indexId}/visual/explain — Explained visual items search

Search

• GET /search/v2/indices/{indexId}/query — Full-text items search
• POST /search/v2/indices/{indexId}/query — Full-text items search
• GET /search/v2/indices/{indexId}/query/explain — Explained full-text items search
• POST /search/v2/indices/{indexId}/query/explain — Explained full-text items search
• GET /search/v2/indices/{indexId}/autocomplete — Autocomplete items search
• POST /search/v2/indices/{indexId}/autocomplete — Autocomplete items search
• GET /search/v2/indices/{indexId}/autocomplete/explain — Explained autocomplete items search
• POST /search/v2/indices/{indexId}/autocomplete/explain — Explained autocomplete items search
• GET /search/v2/indices/{indexId}/explain-match — Searchable attributes match
• GET /search/v2/indices/{indexId}/deleted-searches — Get deleted searches
• POST /search/v2/indices/{indexId}/deleted-searches — Soft-delete a recent search
• GET /search/v2/indices/{indexId}/recent-searches — Get recent searches

Listing

• GET /search/v2/indices/{indexId}/list — Items listing
• POST /search/v2/indices/{indexId}/list — Items listing
• GET /search/v2/indices/{indexId}/list/explain — Explained items listing
• POST /search/v2/indices/{indexId}/list/explain — Explained items listing

Search Configuration

• GET /search/v2/indices/{indexId}/attributes/filterable/values — Get values of filterable attributes
• GET /search/v2/indices — Get configurations of all indices
• POST /search/v2/indices — Post index configuration
• GET /search/v2/indices/{indexId}/config — Get index configuration
• PUT /search/v2/indices/{indexId}/config — Update index configuration
• DELETE /search/v2/indices/{indexId}/config — Delete index configuration
• GET /search/v2/indices/{indexId}/state — Get index state
• GET /search/v2/supported-languages — Get supported languages
• GET /search/v2/indices/{indexId}/duplicate — Duplicate index

Suggestions Configuration

• GET /search/v2/suggestion-indices — Get suggestion indices
• POST /search/v2/suggestion-indices — Create suggestion index
• GET /search/v2/suggestion-indices/{indexId}/config — Get suggestion index
• PUT /search/v2/suggestion-indices/{indexId}/config — Create/replace suggestion index
• DELETE /search/v2/suggestion-indices/{indexId}/config — Delete suggestion index
• GET /search/v2/suggestion-indices/{indexId}/state — Get suggestion index state

AI: Metrics

• GET /metrics/v2/available — Check available metrics (recommendations)
• GET /metrics/v2/available-ids — Retrieve IDs of available metrics (recommendations)

Data Processing Job Logs

• GET /morph/logs/automation/{automationWorkflowId}/last-run/with-stages — Get last log with stages

Promotions

• GET /v4/promotions/promotion/get-for-client — Get a Profile's promotions as Profile
• POST /v4/promotions/promotion/duplicate — Duplicate existing promotion
• POST /v4/promotions/promotion/activate — Activate a promotion
• POST /v4/promotions/promotion/batch-activate — Batch activate promotions
• POST /v4/promotions/promotion/deactivate — Deactivate a promotion
• POST /v4/promotions/promotion/batch-deactivate — Batch deactivate promotions
• POST /v4/promotions/promotion/deactivate-all-for-client/{identifierType}/{identifierValue} — Deactivate all promotions for a Profile as Workspace
• POST /v4/promotions/promotion/redeem — Redeem a promotion
• POST /v4/promotions/promotion/batch-redeem — Batch redeem promotions
• GET /v4/promotions/v2/promotion/get-for-client/{identifierType}/{identifierValue} — Get a Profile's promotions as Workspace (v2)
• GET /v4/promotions/promotion/get-item-for-client/{identifierType}/{identifierValue} — View promotion details as Profile
• GET /v4/promotions/promotion/get-item-for-client-no-data/{identifierType}/{identifierValue} — View promotion details as Profile
• GET /v4/promotions/promotion/list — View Workspace promotions
• GET /v4/promotions/promotion/diff-list — View recently updated promotions
• GET /v4/promotions/promotion/get-for-client/{identifierType}/{identifierValue} — Get a Profile's promotions as Workspace
• GET /v4/promotions/promotion/get-for-client-possible-to-redeem/{identifierType}/{identifierValue} — Get redeemable promotions of a Profile
• GET /v4/promotions/promotion/{identifierType}/{identifierValue} — Get promotion details as Workspace
• PUT /v4/promotions/promotion/{identifierType}/{identifierValue} — Update a promotion
• GET /v4/promotions/promotion/get-for-client-by-custom-settings/{identifierType}/{identifierValue} — Get Profile promotions by a custom filter
• POST /v4/promotions/promotion/activate-for-client/{identifierType}/{identifierValue} — Activate a promotion as Workspace
• POST /v4/promotions/promotion/batch-activate-for-client/{identifierType}/{identifierValue} — Batch activate promotions as Workspace
• POST /v4/promotions/promotion/deactivate-for-client/{identifierType}/{identifierValue} — Deactivate a promotion as Workspace
• POST /v4/promotions/promotion/batch-deactivate-for-client/{identifierType}/{identifierValue} — Batch deactivate promotions
• POST /v4/promotions/promotion — Create a promotion
• DELETE /v4/promotions/promotion — Delete a promotion
• POST /v4/promotions/promotion/create-or-update — Create or update a promotion
• POST /v4/promotions/voucher/batch-redeem — Batch redeem vouchers
• POST /v4/promotions/voucher/batch-redeem-for-profile — Batch redeem vouchers for profiles
• POST /v4/promotions/v2/promotion/batch — Batch import promotions
• DELETE /v4/promotions/v2/promotion/batch — Batch delete promotions
• POST /v4/promotions/v2/sale/process-sale/{identifierType}/{identifierValue} — Process basket
• POST /v4/promotions/sale/process-checkout/{identifierType}/{identifierValue} — Process checkout on POS
• POST /v4/promotions/v2/sale/process-anonymous-sale — Process anonymous Profile's basket
• POST /v4/promotions/sale/process-anonymous-checkout — Process anonymous Profile's checkout on POS

Promotion locks

• GET /v4/promotions/promotion/locking/check-client — Check account lock
• POST /v4/promotions/lock/create-points-lock-for-client/{identifierType}/{identifierValue} — Create point lock for profile
• POST /v4/promotions/lock/release-points-lock-for-client/{identifierType}/{identifierValue}/{lockIdentifier} — Release point lock for profile
• POST /v4/promotions/lock/release-promotion-requested-lock-for-client/{identifierType}/{identifierValue}/{lockIdentifier} — Release "promotion requested" lock from profile

Handbills

• GET /v4/promotions/handbill — Get all handbill configurations
• POST /v4/promotions/handbill — Create handbill configuration
• GET /v4/promotions/handbill/{handbillUuid} — Get handbill configuration
• PATCH /v4/promotions/handbill/{handbillUuid} — Update handbill configuration
• GET /v4/promotions/promotion/get-for-client/handbill/{handbillUuid} — Generate handbill for Profile
• GET /v4/promotions/promotion/get-for-client/handbills — Generate batch of handbills for Profile
• GET /v4/promotions/promotion/get-for-client/{identifierType}/{identifierValue}/handbill/{handbillUuid} — Generate handbill for Profile and get Profile promotions
• GET /v4/promotions/v2/promotion/get-for-client/{identifierType}/{identifierValue}/handbill/{handbillUuid} — Generate handbill for Profile (v2)
• GET /v4/promotions/promotion/get-for-client/{identifierType}/{identifierValue}/with-handbills — Generate batch handbill for Profile and get Profile promotions

Promotion settings

• GET /v4/promotions/settings — Get settings for current Workspace
• PUT /v4/promotions/settings — Update settings for current Workspace

Promotions points

• POST /v4/promotions/v2/points/transfer — Transfer points to another profile

Query Rules

• GET /search/v2/indices/{indexId}/rules — Get rules
• POST /search/v2/indices/{indexId}/rules — Create rule
• GET /search/v2/indices/{indexId}/rules/{ruleId} — Get rule
• PUT /search/v2/indices/{indexId}/rules/{ruleId} — Update query rule
• DELETE /search/v2/indices/{indexId}/rules/{ruleId} — Delete rule
• POST /search/v2/indices/{indexId}/rules/{ruleId}/activate — Activate rule
• POST /search/v2/indices/{indexId}/rules/{ruleId}/pause — Pause rule
• POST /search/v2/indices/{indexId}/rules/{ruleId}/draft — Draft rule
• POST /search/v2/indices/{indexId}/rules/{ruleId}/finish — Finish rule

Recommendation campaigns

• GET /recommendations/v2/campaigns — Get all recommendation campaigns
• POST /recommendations/v2/campaigns — Create a recommendation campaign
• GET /recommendations/v2/campaigns/{campaignId} — Get recommendation campaign details
• POST /recommendations/v2/campaigns/{campaignId} — Update a recommendation campaign
• DELETE /recommendations/v2/campaigns/{campaignId} — Delete a recommendation campaign
• POST /recommendations/v2/campaigns/state — Change campaigns' states
• POST /recommendations/v2/campaigns/{campaignId}/copy — Copy a recommendation campaign
• GET /recommendations/v2/campaigns/simplified — Get simplified recommendation campaigns

Recommendations

• GET /recommendations/v2/recommend/campaigns/{campaignIdentifier} — Get recommendations by campaign
• POST /recommendations/v2/recommend/campaigns — Get recommendations by campaign
• POST /recommendations/v2/recommend/campaigns/{campaignIdentifier}/by/{identifierName} — Get recommendations by campaign and profile identifier
• POST /recommendations/v2/recommend/campaigns/preview — Preview campaign recommendations
• GET /recommendations/v2/recommend/items/users/{clientUuid} — Personalized recommendations
• POST /recommendations/v2/recommend/items/users/{clientUuid} — Personalized recommendations
• POST /recommendations/v2/recommend/items/users/{clientUuid}/sections — Section recommendations
• POST /recommendations/v2/recommend/items/users/{clientUuid}/attributes — Attribute recommendations
• GET /recommendations/v2/recommend/items/users/{clientUuid}/last — Last viewed recommendations
• POST /recommendations/v2/recommend/items/users/{clientUuid}/last — Last viewed recommendations
• GET /recommendations/v2/recommend/items/users/{clientUuid}/aggregates/{aggregateUUID} — Recent interactions recommendations
• POST /recommendations/v2/recommend/items/users/{clientUuid}/aggregates/{aggregateUUID} — Recent interactions recommendations
• GET /recommendations/v2/recommend/items/metric — Scoring by metric
• POST /recommendations/v2/recommend/items/metric — Scoring by metric
• GET /recommendations/v2/recommend/items/complementary — Complementary items for a cart
• POST /recommendations/v2/recommend/items/complementary — Complementary items for a cart
• GET /recommendations/v2/recommend/items/{itemId}/complementary — Complementary items
• POST /recommendations/v2/recommend/items/{itemId}/complementary — Complementary items
• GET /recommendations/v2/recommend/items/{itemId}/similar — Similar items
• POST /recommendations/v2/recommend/items/{itemId}/similar — Similar items
• GET /recommendations/v2/recommend/items/{itemId}/similar/visual — Visually similar
• POST /recommendations/v2/recommend/items/{itemId}/similar/visual — Visually similar
• GET /recommendations/v2/recommend/items/next-interaction — Next interaction
• POST /recommendations/v2/recommend/items/next-interaction — Next interaction

Profile registration

• POST /sauth/clients/registered — Register a Profile
• POST /sauth/clients/activation/by-pin-code/confirmation — Confirm registration with PIN code
• POST /sauth/clients/activation/by-pin-code/request — Re-send PIN code
• POST /sauth/clients/activation/confirmation — Activate a Profile's account
• POST /sauth/clients/activation/request — Re-send email confirmation

Authorization

• POST /sauth/v3/auth/refresh/client — Refresh a Profile token
• POST /sauth/v3/auth/login/client — Authenticate as Profile
• POST /sauth/v3/auth/server/login/client — Authenticate Profile with a server
• POST /sauth/v3/auth/login/client/conditional — Authenticate as Profile (conditional)
• POST /sauth/v3/auth/login/client/anonymous — Authenticate anonymously
• POST /uauth/auth/login/user — Log in as User
• POST /uauth/auth/login/user/mfa/verification — Verify User multi-factor authentication
• POST /uauth/auth/login/user/profile/{businessProfileUUID} — Select Workspace
• GET /uauth/business-profile/ — Get Workspaces
• GET /uauth/business-profile/ids — Get Workspaces ids with user-specific data
• GET /uauth/business-profile/current — Get current Workspace
• POST /uauth/v2/auth/login/profile — Log in as Workspace

Screen views

• GET /schema-service/v3/screen-views/{feedSlug}/generate — Generate screen view from feed
• POST /schema-service/v3/screen-views/{feedSlug}/generate — Generate screen view from feed
• POST /schema-service/screen-views/create — Create screen view
• POST /schema-service/v2/screen-views/createNew — Initialize screen view
• POST /schema-service/v2/screen-views/{screenViewId}/content — Add content to screen view
• POST /schema-service/v2/screen-views/{screenViewId}/audience — Add audience to screen view
• PUT /schema-service/v2/screen-views/{screenViewId}/priority — Update screen view priority
• PUT /schema-service/v2/screen-views/{screenViewId}/name — Rename screen view
• POST /schema-service/v2/screen-views/{feedSlug}/generate/by/{identifierType} — Preview screen view with a profile context
• GET /schema-service/v2/screen-views/feeds — List screen view feeds
• POST /schema-service/v2/screen-views/feeds — Create screen view feed
• GET /schema-service/v2/screen-views — List screen views
• GET /schema-service/v2/screen-views/{screenViewId} — Get screen view
• DELETE /schema-service/v2/screen-views/{screenViewId} — Delete screen view
• POST /schema-service/v2/screen-views/{screenViewId}/copy — Copy screen view
• GET /schema-service/v2/screen-views/{screenViewId}/predecessors — Get predecessors for screen view
• GET /schema-service/v2/screen-views/{screenViewId}/successors — Get successors for screen view
• GET /schema-service/v2/screen-views/directory — List screen view directories
• POST /schema-service/v2/screen-views/directory — Add screen view directory
• POST /schema-service/v2/screen-views/directory/{directoryId} — Rename screen view directory
• DELETE /schema-service/v2/screen-views/directory/{directoryId} — Delete screen view directory
• POST /schema-service/v2/screen-views/{screenViewId}/directory/{directoryId}/attach — Assign screen view to directory
• POST /schema-service/v2/screen-views/{screenViewId}/feed — Assign screen view to feed
• POST /schema-service/v2/screen-views/feeds/{feedId} — Rename screen view feed
• DELETE /schema-service/v2/screen-views/feeds/{feedId} — Delete screen view feed
• POST /schema-service/scheduler/entry — Schedule object
• GET /schema-service/scheduler/entry/{objectType}/{objectId} — Get schedule the schedule of an object
• POST /schema-service/v2/screen-views/{screenViewId}/status/finish — Finish screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/resume — Resume screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/activate — Activate screen view
• POST /schema-service/v2/screen-views/{screenViewId}/status/pause — Pause screen view

Documents

• GET /schema-service/v2/documents/{slug}/generate — Generate document (slug)
• POST /schema-service/v2/documents/{slug}/generate — Generate document (slug)
• POST /schema-service/v2/documents/{documentId}/generate — Generate document (document UUID)
• POST /schema-service/v2/documents/create — Create document
• POST /schema-service/v2/documents/createNew — Initialize document
• POST /schema-service/v2/documents/{documentId}/audience — Add audience to document
• POST /schema-service/v2/documents/{documentId}/content — Add content to document
• PUT /schema-service/v2/documents/{documentId}/name — Rename document
• PUT /schema-service/v2/documents/{documentId}/priority — Update priority in document
• POST /schema-service/v2/documents/preview/by/{identifierType} — Preview document content for a profile
• POST /schema-service/v2/documents/{documentIdentifier}/generate/by/{identifierType} — Generate document for a profile
• POST /schema-service/v2/documents/preview/grouped-by/groups/list — List grouped documents
• GET /schema-service/v2/documents — List documents
• POST /schema-service/v2/documents/preview/list — List documents from groups
• GET /schema-service/v2/documents/{slug} — Get document by slug
• GET /schema-service/v2/documents/by/slug/{slug}/predecessors — Get predecessors for document
• GET /schema-service/v2/documents/{documentId}/predecessors — Get predecessors for document
• GET /schema-service/v2/documents/by/slug/{slug}/successors — Get successors for document
• GET /schema-service/v2/documents/{documentId}/successors — Get successors for document
• GET /schema-service/v2/documents/{documentId} — Get document by UUID
• POST /schema-service/v2/documents/{documentId} — Update document
• DELETE /schema-service/v2/documents/{documentId} — Delete document
• POST /schema-service/v2/documents/{documentId}/copy — Copy document
• POST /schema-service/v2/documents/{documentId}/directory/{directoryId}/attach — Assign document to directory
• POST /schema-service/v2/documents/directory/{directoryId} — Rename document directory
• DELETE /schema-service/v2/documents/directory/{directoryId} — Delete document directory
• GET /schema-service/v2/documents/directory — List document directories
• POST /schema-service/v2/documents/directory — Add document directory
• DELETE /schema-service/v2/groups/{groupId} — Delete document group
• GET /schema-service/v2/groups — List groups
• POST /schema-service/v2/groups — Add group
• POST /schema-service/v2/documents/{documentId}/status/finish — Finish document
• POST /schema-service/v2/documents/{documentId}/status/activate — Activate document
• POST /schema-service/v2/documents/{documentId}/status/resume — Resume document
• POST /schema-service/v2/documents/{documentId}/status/pause — Pause document
• GET /schema-service/schemaTypes — Get schema types
• POST /schema-service/schemaTypes — Add schema type
• DELETE /schema-service/schemaTypes — Delete schema types

Screen views (legacy)

• GET /schema-service/screenViews — Get all screen views (deprecated)
• POST /schema-service/screenViews/byKeys — Get screen views by keys (deprecated)
• GET /schema-service/screenViews/single/{screenViewId}/{screenViewVersion} — Get screen view (deprecated)
• GET /schema-service/screenViews/versions/{screenViewId} — Get screen view versions (deprecated)
• GET /schema-service/screenViews/generate — Generate screen view (deprecated)
• GET /schema-service/v2/screenViews/generate — Generate screen view (deprecated)
• POST /schema-service/screenViews/createNew — Initialize screen view (deprecated)
• POST /schema-service/screenViews/content/{screenViewId}/{screenViewVersion}/copyFromExistingScreenView — Copy content (deprecated)
• POST /schema-service/screenViews/content/{screenViewId}/{screenViewVersion} — Add content (deprecated)
• POST /schema-service/screenViews/audience/{screenViewId}/{screenViewVersion} — Add audience (deprecated)
• POST /schema-service/screenViews/publish/{screenViewId}/{screenViewVersion} — Publish screen view (deprecated)
• POST /schema-service/screenViews/copyDraftFromExistingScreenView — Copy draft from existing screen view (deprecated)
• POST /schema-service/screenViews/createDraftFromExistingScreenView — Create draft from existing screen view (deprecated)
• PUT /schema-service/screenViews/single/{screenViewId}/{screenViewVersion}/description — Update screen view description (deprecated)
• PUT /schema-service/screenViews/single/{screenViewId}/{screenViewVersion}/priority — Update screen view priority (deprecated)
• POST /schema-service/screenViews/discardChanges/{screenViewId}/{screenViewVersion} — Discard changes (deprecated)
• DELETE /schema-service/screenViews/delete/{screenViewId} — Delete screen view (deprecated)
• DELETE /schema-service/screenViews/single/delete/{screenViewId}/{screenViewVersion} — Delete screen view version (deprecated)

Documents (legacy)

• POST /schema-service/document/preview — Preview document (deprecated)
• POST /schema-service/document/{uuid} — Create document version (deprecated)
• GET /schema-service/document/{id} — Get raw document (deprecated)
• POST /schema-service/document/{uuid}/{id} — Update document (deprecated)
• GET /schema-service/v2/document/slug/{slug}/content — Generate processed document (only content) (deprecated)
• GET /schema-service/document/slug/{slug}/content — Generate processed document (only content) (deprecated)
• POST /schema-service/document/slug/{slug}/content — Generate processed document (only content) (deprecated)
• GET /schema-service/document/certification/{slug} — Generate certification document with specific slug. (deprecated)
• GET /schema-service/document/slug/{slug} — Generate processed document (deprecated)
• POST /schema-service/document/slug/{slug} — Generate processed document (deprecated)
• GET /schema-service/document/by-schema/{schema} — Generate documents by schema (deprecated)
• GET /schema-service/document — List documents (deprecated)
• POST /schema-service/document — Create document (deprecated)
• DELETE /schema-service/document — Delete documents (deprecated)
• GET /schema-service/document/{uuid}/versions — Get document versions (deprecated)
• POST /schema-service/document/{uuid}/publish — Publish document (deprecated)
• GET /schema-service/document/slug/{slug}/check — Check if slug is correct (deprecated)

Synonyms

• GET /search/v2/indices/{indexId}/synonyms — Get synonyms
• POST /search/v2/indices/{indexId}/synonyms — Create synonym
• POST /search/v2/indices/{indexId}/synonyms/batch — Batch insert synonyms
• POST /search/v2/indices/{indexId}/synonyms/replace-all — Replace all synonyms
• GET /search/v2/indices/{indexId}/synonyms/{synonymId} — Get synonym
• PUT /search/v2/indices/{indexId}/synonyms/{synonymId} — Update synonym
• DELETE /search/v2/indices/{indexId}/synonyms/{synonymId} — Delete synonym

Asset tags

• GET /tags-collector/directories — Get all directories
• POST /tags-collector/directories — Create directory
• GET /tags-collector/directories/types — Get directory types
• POST /tags-collector/directories/types — Create directory type
• PATCH /tags-collector/directories/{directoryHash} — Update directory
• DELETE /tags-collector/directories/{directoryHash} — Delete directory
• GET /tags-collector/directories/{directoryHash}/tags — Get tags from directory
• POST /tags-collector/directories/{directoryHash}/tags — Assign tags to directory
• DELETE /tags-collector/directories/{directoryHash}/tags — Unassign tags from directory
• PUT /tags-collector/directories/{directoryHash}/types — Update directory type
• GET /tags-collector/tags — Get tag list
• POST /tags-collector/tags — Create tag
• PATCH /tags-collector/tags/{tagHash} — Update tag

Templates

• GET /template-backend/template — List templates
• POST /template-backend/template — Create template
• GET /template-backend/template/{templateUuid} — Get template by UUID
• PATCH /template-backend/template/{templateUuid} — Patch a template
• POST /template-backend/template/functional — Create functional template
• POST /template-backend/template/move — Move templates to another directory
• POST /template-backend/template/remove — Remove templates
• GET /template-backend/template/getById/{id} — Get template by ID
• POST /template-backend/upload/zip — Create template from ZIP
• POST /template-backend/upload/url — Create template from URL

Template directories

• GET /template-backend/directory — Get directories
• POST /template-backend/directory — Create directory
• GET /template-backend/directory/byType — Get directories by type
• PATCH /template-backend/directory/{directoryUUID} — Rename directory
• DELETE /template-backend/directory/{directoryUUID} — Remove directory

Access control

• POST /uauth/business-profile/mfa/requirements — Enable MFA requirement for workspace
• DELETE /uauth/business-profile/mfa/requirements — Disable MFA requirement for workspace
• GET /uauth/users/my-account/strongest-password-settings — Get own strongest password policy
• GET /uauth/settings/user-bp-ip-policy — Get IP allowlist policy
• POST /uauth/settings/user-bp-ip-policy — Update IP allowlist policy
• GET /uauth/strongest-password-settings-by-email/{email} — Get strongest password policy of a User
• POST /uauth/users/mfa/initialization — Initiate multi-factor authentication for user
• POST /uauth/users/mfa/confirmation — Confirm multi-factor authentication for user
• DELETE /uauth/users/mfa — Remove multi-factor authentication for user
• GET /uauth/settings/password-policy — Get user password policy
• POST /uauth/settings/password-policy — Update user password policy

User account management

• POST /uauth/change-password — Change user password
• POST /uauth/password-reset/request — Request user password reset
• POST /uauth/password-reset/confirmation — Confirm user password reset
• GET /uauth/user/confirmation/{confirmationToken} — Confirm user registration
• POST /uauth/user/register — Register user
• POST /uauth/user/register/resend-confirmation — Re-send user confirmation token
• GET /uauth/users/my-account — Get user's own data
• POST /uauth/users/my-account — Update user's own data
• DELETE /uauth/users/my-account — Delete user's own account

Access groups

• GET /uauth/permissions/group/role/{roleId} — List grouped permissions
• GET /uauth/roles/listing — Get role groups
• POST /uauth/roles/role-group — Create role group
• POST /uauth/roles/role-group/{groupId} — Update role group
• DELETE /uauth/roles/role-group/{groupId} — Delete role group
• POST /uauth/roles/role — Create role
• GET /uauth/roles/{roleId} — Get role
• POST /uauth/roles/role/{roleId} — Update role
• DELETE /uauth/roles/role/{roleId} — Delete role
• GET /uauth/users/available-roles — Get available roles

User management

• GET /uauth/user/register/invitation/{invitationToken} — Find user by invitation token
• POST /uauth/users/invitations/invite — Invite user
• POST /uauth/users/invitations/invite-bulk — Invite many users
• DELETE /uauth/users/invitations/{invitationIds} — Delete invitations
• POST /uauth/users/invitations/{invitationId} — Update invitation
• GET /uauth/users/listing — List users
• GET /uauth/users/listing/autocomplete — Autocomplete user search result
• DELETE /uauth/users/profile-association/{ids} — Remove users from workspace
• GET /uauth/users/{userId} — Get user data
• POST /uauth/users/{userId} — Update user data
• POST /uauth/users/activate — Activate users
• POST /uauth/users/deactivate — De-activate users
• PUT /uauth/users/{userId}/access-time — Change access expiration time
• POST /uauth/users/{userId}/password-reset — Reset another user's password
• PUT /uauth/users/{userId}/mfa-reset — Reset another user's multi-factor authentication
• DELETE /uauth/users/{ids} — Delete user account

Directory

• GET /uauth/managed-domains — List managed domains
• DELETE /uauth/managed-domains — Delete managed domain
• GET /uauth/managed-domains/initialize-code — Initialize managed domain
• POST /uauth/managed-domains/verification — Verify managed domain

Uploader

• POST /uploader-service/clients/files/by/{identifierType} — Add files for dynamic attachments
• POST /uploader-service/storages/{container}/upload — Upload file
• GET /uploader-service/storage-files/list — List files from workspace
• GET /uploader-service/v2/list — List files from workspace
• POST /uploader-service/storage-files/delete-by-uuid — Remove files
• POST /uploader-service/storage-files/add-star-by-uuid — Add stars
• POST /uploader-service/storage-files/remove-star-by-uuid — Remove stars

Vouchers

• POST /v4/vouchers/item/assign — Assign a voucher from a pool to Profile
• GET /v4/vouchers/item/get-assigned — Get assigned vouchers
• POST /v4/vouchers/item/get-or-assign — Get or assign and get voucher as Profile
• POST /v4/vouchers/item — Create a voucher
• POST /v4/vouchers/item/bulk-create — Bulk create vouchers
• GET /v4/vouchers/item/list — List all vouchers
• GET /v4/vouchers/item/{voucherUuid} — View voucher details
• PUT /v4/vouchers/item/{voucherUuid} — Update a voucher
• DELETE /v4/vouchers/item/{voucherUuid} — Delete a voucher
• GET /v4/vouchers/item/{searchKey}/{searchValue} — View voucher details by search key
• POST /v4/vouchers/item/assign-for-client — Assign a voucher to a Profile
• GET /v4/vouchers/item/get-assigned-for-client/{clientUuid} — Get vouchers assigned to a Profile (deprecated)
• POST /v4/vouchers/item/get-or-assign-for-client — Get or assign and get voucher as Workspace (deprecated)
• GET /v4/vouchers/item/get-assigned-for-client/by-identifier — Get vouchers assigned to a Profile by identifier
• POST /v4/vouchers/item/get-or-assign-for-client/by-identifier — Get or assign and get voucher as Workspace
• POST /v4/vouchers/item/assign-for-client/by-identifier — Assign and get voucher as Workspace
• POST /v4/vouchers/item/redeem — Redeem a voucher
• GET /v4/vouchers/pool/list — List pools
• POST /v4/vouchers/pool — Create a voucher pool
• GET /v4/vouchers/pool/{poolUuid} — Get pool details
• PUT /v4/vouchers/pool/{poolUuid} — Update a voucher pool
• DELETE /v4/vouchers/pool/{poolUuid} — Delete a voucher pool
• GET /v4/vouchers/item/list/{poolUuid} — List vouchers from a pool
• DELETE /v4/vouchers/item/list/{poolUuid} — Delete vouchers by poolUuid
• POST /v4/vouchers/item/count/{poolUuid} — Count vouchers

Back to all API categories