Jump to Content
Guides
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
Guides
API Reference
Lookup account by external IDs
Search
All
Pages
Start typing to search…
JUMP TO
Kigo API
Advertisements
Retrieves advertisements for a user based on program campaign ID and location.
get
Authentication
Creates a new API session token for partner authentication. This endpoint allows partners to obtain a session token that will be used for subsequent API calls. The session token expires after 30 minutes.
post
Creates an API session token for a user account within a partner's account space. This endpoint allows creating both access and refresh tokens for user authentication. The access token expires after 1 hour while the refresh token lasts for 1 year.
post
Refreshes an expired account space API session token using a valid refresh token. This endpoint allows users to obtain new access tokens without requiring re-authentication. The new tokens maintain the same security level as the original tokens.
post
Authenticates a user using their email address within a partner's account space. This endpoint validates the email and checks if the user has previously claimed an access code. Upon successful authentication, it returns access and refresh tokens.
post
Process a SAML response.
post
Get the SAML login URL for the given entity ID..
get
Accounts
Create a Kigo account on behalf of a user.
post
Initialize a credential belonging to a Kigo account on behalf of an external user.
post
Get account credentials for a program.
get
Reissue a credential belonging to a Kigo account on behalf of an external user.
patch
Retrieve the profile of the current user.
patch
Retrieve an account's token history.
get
Retrieve the profile of the current user.
get
Update the profile of the current user.
patch
Create an sso session for a user.
post
/api/v1/accounts/stage
get
/api/v1/accounts/stage
patch
Retrieve the current survey for the authenticated user.
get
Post survey answers for the current user.
post
Programs
Get all programs associated with the partner.
get
/api/v1/programs/branding
get
Get a program by its external id.
get
Get program edition categories by partner ID and optional program ID.
get
Get the Kigo contracts associated with a program.
get
Get program placement configuration by program_id or external_program_id
get
/api/v1/programs/{external_program_id}/partner
get
Get program ui ux config typography by partner ID and optional program ID.
get
/api/v1/programs/ui-ux-config/welcome-modal-configuration
get
Get program chip filters with their static and dynamic query configurations
get
Get a program by its external id.
get
Bundles
Place an order for a bundle.
post
Gallery
Get the gallery of tokens belonging to a user account.
get
Sort tokens in gallery view.
patch
Products
Get a list of filtered products associated with a program.
get
Get the details of a product.
get
Create a claim code for a product.
post
/api/v1/tokens/{token_id}/reveal/offer/online
post
/api/v1/tokens/{token_id}/reveal/offer/in-store
post
/api/v1/tokens/{token_id}/reveal/offer/phone
post
Tags
Get a list of tags.
get
Tokens
Retrieve tokens and associated products by claim code.
get
Claim a token using a claim code.
post
Initialize a token for an account.
post
Create a token from an Offer Id
post
Retrieve full details of a token by its ID.
get
Retrieve the files associated with a token by its ID.
get
Update the hidden status of a token by setting its is_hidden flag.
post
Redeem an offer token with no endeca key.
post
Redeem a link
post
Redeem a promo code token.
post
Redeem a qr-connect-and-save token.
post
Redeem a show-and-save token.
post
Redeem a show-and-save token.
post
Redeem a voucher token
post
/api/v1/tokens/{token_id}/reroll
post
Reveal a bundle token.
post
Reveal a gift card.
post
Share a token with another user.
post
Cancel a pending shared token.
del
User Feedback
/api/v1/user-feedback/{token_id}
post
Post Redemption Survey
/api/v1/tokens/{token_id}/post-redemption-survey
post
Utils
Fetches the MapQuest API key
get
Convert lat and long to an address.
post
Autocomplete
get
Convert an Address to lat and long.
post
Get place details
get
Access code
/api/v1/access-codes
post
/api/v1/access-codes/{code}
get
Communication Preferences
Upsert communication preferences for an account.
post
Model Context Protocol
/api/v1/api/v1/mcp/call-tool
post
/api/v1/api/v1/mcp/list-tools
get
handlers::api::v1::auth
Get authentication configuration for a partner. This endpoint returns the authentication configuration for a specific partner, returning only the partner-level configuration without hierarchical resolution.
get
Get authentication configuration for a program. This endpoint returns the effective authentication configuration for a program, following the hierarchical resolution: program → partner → default.
get
Members
Enrolls a member in the rewards network
post
Retrieves a member's rewards network ID by their account ID
get
Deactivate a member in the Rewards Network.
del
/api/v1/members/{member_id}/cards
get
/api/v1/members/{member_id}/cards
post
/api/v1/members/{member_id}/cards/{card_id}
del
/api/v1/members/{member_id}/status
get
Merchants
Retrieves details for a specific merchant.
get
Retrieves the locations for a specific merchant.
get
This endpoint fetches the details for a specific merchant location identified by their `merchant_id` and `location_id`.
get
DEPRECATED: This endpoint is deprecated and no longer used on the frontend. will be removed in the future. This endpoint fetches google images for a merchant location.
get
Notifications
/api/v1/notifications
get
/api/v1/notifications
post
/api/v1/notifications
patch
/api/v1/notifications/onesignal
get
Offers
Retrieves a list of offers.
get
Retrieves offers count.
get
Retrieves a list of counts for each requested category.
get
Retrieves a list of counts for each requested offer type.
get
Retrieves a list of counts for each requested offer redemption type.
get
Get featured offers for a given location based on partner and program IDs
get
Retrieves offers map clusters.
get
Retrieve a list of trending merchants.
get
Get popular offers for a given location
get
Sends an SMS containing a deep link to the wallet details page for a specific token.
post
Retrieves the user's offer redemption history.
get
Get trending offers for a given location
get
Retrieve offer details by unique ID.
get
Checks the availability of a specific offer.
get
Creates a post-redemption survey for a specific offer.
post
Redeems a specific offer.
post
Creates user feedback for a specific offer.
post
Personalization
/api/v1/personalization
post
Product Configurations
Get the hosted wallet configuration for a given domain.
get
Program Campaign Configurations
/api/v1/program-campaign-configurations/{program_campaign_id}
get
Program campaigns
/api/v1/program-campaigns/messages
get
/api/v1/program-campaigns/account
get
/api/v1/program-campaigns/{program_campaign_id}
get
handlers::api::v1::sso::saml
Get the SAML metadata for the service provider.
get
Statement Credits
Get the balance for a member
get
Get the credits for a member
get
Get the dines for a member
get
Validation
/api/v1/tokens/{token_id}/validate/proof-of-purchase
post
Update metadata related to a proof of purchase.
patch
Accounts
Lookup account by external IDs
get
Get the credential type of the current account.
get
Get hub summary for an account
get
Powered by
Lookup account by external IDs
get
https://kigo-core-server-test.kigodigital.net/api/v1/accounts
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
Bearer
URL
Base URL
https://kigo-core-server-test.kigodigital.net
/api/v1/accounts
Response
Click
Try It!
to start a request and see the response here!