Jump to Content

Home Guides API Reference

API Reference

Jump to Content

Home Guides API Reference

All

Pages

Start typing to search…

Getting Started - BETA
My Requests

Account

Core
Identifiers
Memberships
Bookings
Coupons
- Get all account coupons for the specified userget
- Get all coupon redemptions for accountget
Transactions

Coupon

Core
Account Assignation
Account Assignation Batch
PromoCode
Account coupon & Promo code
Images

Transaction

Core

Program

Blacklists
Custom Properties
Endpoint
Product Catalog
Interaction Points
Operations
- Get API operations for a programget
Partners
Stores
Partner Blacklists
Rating
- Config
- Levels
  - Get rating levels for programget
  - Get a rating level for programget
Status Level
Resources
Tag
Events
- Get all events for the specified membershipget

Connectors

Core
Health
- getget

Webhook

Actions
- Core
- Config
History
- Retrieve a single Historyget
- Retrieve multiple Historiesget
Events
- Retrieve a single Eventget
- Retrieve multiple Eventsget
Domain Type
- /webhooks/domain-typeget
Integration
Operations
- /webhooks/operationsget

Newsfeed

Core
Post
Post Assignment
Target Audience
Health
- Health checkget

User

Core
Identifier
- return the specific Identifierget
- Terminates an Identifierdel
Identifier Batch
Authentication
- Performs a login with username and passwordpost
- Performs a logout of the currently logged in userdel
Events
- Get all events for the specified userget

Push Notification

Notification
Targets
- Get targetget
Health
- Health checkget
- getget

Reports

Account Booking
- /reports/v3/account-booking/exportget
- Returns a list of accounts bookingsget
Account
- /reports/v3/account/exportget
- Returns a list of accountsget
Account Coupon
- /reports/v3/account-coupon/exportget
- Returns a list of accounts couponsget
Account Coupon Activations
- /reports/v3/account-coupon-activations/exportget
- Returns a list of coupon activationsget
Account Level Booking
- /reports/v3/account-level-booking/exportget
- Returns a list of accounts level bookingsget
Account Snapshot
- /reports/v3/account-snapshot/exportget
- Returns a list of accounts snapshotsget
Account Status Level
- /reports/v3/account-status-level/exportget
- Returns a list of accounts status levelsget
Account User
- /reports/v3/account-user/exportget
- Returns a list of accounts with usersget
Account Identifier
- /reports/v3/account-identifier/exportget
- Returns a list of accounts identifiersget
Account Balance
- /reports/v3/account-balance/exportget
- Returns a list of accounts with usersget
Coupon
- /reports/v3/coupon/exportget
- Returns a list of couponsget
Coupon Redemption
- /reports/v3/coupon-redemption/exportget
- Returns a list of coupon redemptionsget
Membership
- /reports/v3/membership/exportget
- Returns a list of membershipsget
Partner
- /reports/v3/partner/exportget
- Returns a list of partnersget
Store
- /reports/v3/store/exportget
- Returns a list of storesget
Transaction
- /reports/v3/transaction/exportget
- Returns a list of transactionsget
User
- /reports/v3/user/exportget
- Returns a list of usersget
Push Token
- /reports/v3/push-tokens/exportget
- Returns a list of push tokensget
InteractionPoint
- /reports/v3/interaction-points/exportget
- Returns a list of interaction pointsget
Segment
- Returns a list of segmentsget
Score
- Returns a list of accountsget

User App Service

Keycloak
- /user-app-service/keycloak/admin/realms/{keycloakRealm}/users/{userId}/organizationsget

Search Service

Searchpost
- Performs a new searchpost

Newsfeed Service

Newsfeed
- /newsfeed-service/v2/newsfeeds/{newsFeedItemId}get
/newsfeed-service/health
- getget
Post
Post v2
- /newsfeed-service/v2/postspost
- /newsfeed-service/v2/posts/{postId}patch
Post Assignment
Newsfeed
Post Assignment v2
Target Audience

Push Notification service

Operations
- List operationsget

Convercus reports

NewsPost
- /reports/v3/news-post/exportget
- Returns a list of postsget

AI Service

newsfeed
- Generate Content (Async)post
- Generate Image (Async)post
Health
- Health checkget
Prompts
Programs
newsfeed
- Get Job Statusget

Device Mounting

/mounting-service/images/upload
- postpost
Health
- /mounting-service/healthget
Devices
Mountings
Profiles
Partners
Programs
Stores
Images

Convercus API

Account Assignation Batch
- Update accounts redemption limitpatch
Account Assignation
- Update account redemption limitpatch

Tracking service

Health
- /tracking-service/healthget

Powered by

Create a new user

post https://staging.convercus.io/users

Adds a user to the system

Language

Credentials

Bearer

JWT

Click Try It! to start a request and see the response here!