For AI agents: visit https://spotlight-neon.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Spotlight NEON
GuidesAPI Reference
Log InSpotlight NEON
API Reference
Log In
GuidesAPI Reference

Working with the NEON APIs

  • Connecting to the APIs
  • What API to use
  • General notes about Json bodies and responses
  • The NEON Loyalty API
  • The NEON Config API
  • The NEON Interact API

Working with the Loyalty API

  • Introduction
  • Query (GET) Endpoints
  • Pagination and Sorting
  • Filtering to limit query results
    • Querying by Member Lookup Id
    • Querying by Entity Lookup Id
    • Query Expressions
  • Save (POST) Endpoints
  • Response Payloads
  • Error Responses
  • Standard Fields

NEON Loyalty API

  • Activities
    • Query Activitiesget
    • Save a new Activitypost
    • Save multiple Activitiespost
  • Loyalty API Admin Support
    • Evalue a body-templatepost
    • Evaluate a SQL templatepost
    • Evaluate a value-expressionpost
  • CMS
    • Get Cms contentget
    • Query CMS Document Resourcesget
  • Codes
    • Query Code Set Resourcesget
    • Pick a Codepost
    • Query Codesget
    • View Codeget
    • Redeem a Codepost
    • Query Codes by Memberget
  • Competitions
    • Query Competition Resourcesget
    • Query Competition entriesget
    • Submit or update an entrypost
    • Save multiple Entriespost
    • View Competition tryget
    • Query Competition Entries by Memberget
  • Custom events
    • Query Custom Resourcesget
    • Submit a Custom eventpost
    • Submit multiple Custom eventspost
  • Tasks
    • Save an export Task to queuepost
    • Generate File URLpost
    • Save an import Task to queuepost
    • Generate File URLget
    • Query Task queueget
    • Save an import Task to queuepost
    • Abort Item Taskpost
    • View Task errorsget
  • Forms
    • Query Form Resourcesget
    • Query Form Membersget
    • Submit Form Memberpost
    • Submit multiple Form Memberspost
    • View Form Memberget
  • Funnels
    • Query Funnel Resourcesget
    • Query Membersget
    • View Funnel Memberget
    • Query Stepsget
    • Save a Steppost
    • Save multiple Stepspost
    • Query Funnels by Memberget
  • Games
    • Query Game Resourcesget
    • Query Highscoresget
    • Query Game playsget
    • Save Game playpost
    • Submit multiple Game playspost
    • View Game playget
    • Query Games by Memberget
  • Journeys
    • Query Journey Resourcesget
    • Query Journey Membersget
    • Start a Journeypost
    • Start multiple Journeyspost
    • View Journey Memberget
    • Query Journeys by Memberget
  • Lists
    • Query List resourcesget
    • Clone a Listpost
    • Manipulate a List from another Listpost
    • Remove List Memberspost
    • Set List column valuespost
    • Copies Members into new Listspost
    • Query List itemget
    • Save List Itempost
    • Save multiple List itemspost
    • View List itemget
    • Query Lists by Memberget
  • Members
    • Query Membersget
    • Save a Memberpost
    • Save multiple Memberspost
    • View Memberget
    • Delete a Memberdel
  • Messages
    • Query Messages by Memberget
    • Query Message Template Resourcesget
    • Query Message Batchesget
    • Send a Messagepost
    • Send multiple Messagespost
    • Query Messagesget
    • View Messageget
  • Offers
    • Query Offers by Memberget
    • Query Offer by Memberget
    • Query Offer Resourcesget
    • Claim an Offerpost
    • Query Offer instancesget
  • Orders
    • Query Orders by Memberget
    • Query Payments by Memberget
    • Query Order Linesget
    • Query Ordersget
    • Save Orderpost
    • View Orderget
    • Query Paymentsget
    • Save Paymentpost
  • Relationships
    • Query Relationships by Memberget
    • Query Relationship Resourcesget
    • Query Relationshipsget
    • Save Relationshippost
    • Save multiple Relationshipspost
  • Sheets
    • Query Sheets by Memberget
    • Query Sheet Resourcesget
    • Query Sheet rowsget
    • Save Sheet Rowpost
    • Save multiple Rowspost
    • View Sheet Rowget
  • Surveys
    • Query Surveys by Memberget
    • Query Survey Resourcesget
    • Query Survey entriesget
    • Submit Surveypost
    • Submit multiple Surveyspost
    • View Survey entryget
  • Votes
    • Query Votes by Memberget
    • Query Vote Resourcesget
    • Query Vote entriesget
    • Submit Votepost
    • Submit multiple Votespost
    • View Vote entryget
  • Wallets
    • Query Wallets by Memberget
    • Save Wallet Transactionpost
    • Submit multiple Transactionspost
    • Query Walletsget
    • View Walletget
    • Query Wallet transactionsget
  • Reporting
    • Database Table Definition Reportget
    • Database Table Size Reportget
    • Dimension Combinations Reportget
    • Dimension combination Entities Reportget
    • Dimension Values Reportget
    • Dimension Value Entities Reportget
    • Entity Stats Reportget
    • Entity Stats Trend Reportget
  • Target Expressions
    • Parses/Validates an Expressionpost
    • Process an Expressionpost
    • Export Target Expression Membersget
    • Modify a Tag List based on a Targetpost
    • Resets an INVALID steppost

NEON Interact API

  • Events
    • Log an eventpost
  • Links
    • Track and Redirect a Linkget

NEON Config API

  • Welcome to the Config API
  • Entity Config
    • Query Entitiesget
    • Add Entitypost
    • Bulk load Entitiespost
    • List field valuesget
    • View Entityget
    • Patch Entitypatch
    • Update Entityput
    • Query Entity referencesget
  • CMS Content Config
    • Query CMS Contentget
    • Save CMS Contentpost
    • Delete CMS Contentdel
  • CMS Definition Config
    • Query CMS Definitionsget
    • Add CMS Definitionpost
    • Delete CMS Definitiondel
    • View CMS Definitionget
    • Patch CMS Definitionpatch
    • Update CMS Definitionput
  • CMS Document Config
    • Query CMS Documentsget
    • Add CMS Documentpost
    • Delete CMS Documentdel
    • View CMS Documentget
    • Patch CMS Documentpatch
    • Update CMS Documentput
  • Code Bank Config
    • Query Code Banksget
    • Add Code Bankpost
    • Delete Code Bankdel
    • View Code Bankget
    • Patch Code Bankpatch
    • Update Code Bankput
  • Code Bank Administration
    • Query Code Batchesget
    • Query Code Bank Codesget
    • View Code Bank Codeget
  • Code Set Config
    • Query Code Setsget
    • Add Code Setpost
    • Delete Code Setdel
    • View Code Setget
    • Patch Code Setpatch
    • Update Code Setput
  • Code Set Administration
    • Query Code Set Codesget
    • Add multiple Code Set Codespost
  • Competition Config
    • Query Competitionsget
    • Add Competitionpost
    • Delete Competitiondel
    • View Competitionget
    • Patch Competitionpatch
    • Update Competitionput
  • Custom Entities Config
    • Query Custom Entitiesget
    • Add Custom Entitypost
    • Delete Custom Entitydel
    • View Custom Entityget
    • Patch Custom Entitypatch
    • Update Custom Entityput
  • Dimension Config
    • Query Dimensionsget
    • Add Dimensionpost
    • Query Dimension Valuesget
    • Add Dimension Valuepost
    • Delete Dimension Valuedel
    • View Dimension Valueget
    • Update Dimension Valueput
    • Delete Dimensiondel
    • View Dimensionget
    • Patch Dimensionpatch
    • Update Dimensionput
  • Form Config
    • Query Formsget
    • Add Formpost
    • Delete Formdel
    • View Formget
    • Patch Formpatch
    • Update Formput
  • Funnel Config
    • Query Funnelsget
    • Add Funnelpost
    • Delete Funneldel
    • View Funnelget
    • Patch Funnelpatch
    • Update Funnelput
  • Game Config
    • Query Gamesget
    • Add Gamepost
    • Delete Gamedel
    • View Gameget
    • Patch Gamepatch
    • Update Gameput
  • Interact Keys
    • List Interact Keyget
    • Generate Interact Keypost
    • Delete Interact Keydel
    • Update Interact Keypost
  • Job Config
    • Query Jobsget
    • Add Jobpost
    • Delete Jobdel
    • View Jobget
    • Patch Jobpatch
    • Update Jobput
  • Job Administration
    • Disable Jobpost
    • Query Job Logsget
    • Reset Jobpost
    • Run the Job Nowpost
  • Journey Config
    • Query Journeysget
    • Add Journeypost
    • Delete Journeydel
    • View Journeyget
    • Patch Journeypatch
    • Update Journeyput
  • List Config
    • Query Listsget
    • Add Listpost
    • Delete Listdel
    • View Listget
    • Patch Listpatch
    • Update Listput
  • Member Config
    • Get Member configurationget
    • Patch Member configurationpatch
    • Update Member configurationput
  • Message Config
    • Query Message Serversget
    • Add Message Serverpost
    • Delete Message Serverdel
    • View Message Serverget
    • Patch Message Serverpatch
    • Update Message Serverput
    • Query Message Templatesget
    • Add Message Templatepost
    • Delete Message Templatedel
    • View Message Templateget
    • Patch Message Templatepatch
    • Update Message Templateput
  • Offer Config
    • Query Offersget
    • Add Offerpost
    • Delete Offerdel
    • View Offerget
    • Patch Offerpatch
    • Update Offerput
  • Order Set Config
    • Query Order Setsget
    • Add Order Setpost
    • Delete Order Setdel
    • View Order Setget
    • Patch Order Setpatch
    • Update Order Setput
  • Relationship Config
    • Query Relationshipsget
    • Add Relationshippost
    • Delete Relationshipdel
    • View Relationshipget
    • Patch Relationshippatch
    • Update Relationshipput
  • Settings Config
    • Query Settingsget
    • Add Settingspost
    • Delete Settingsdel
    • View Settingsget
    • Patch Settingspatch
    • Update Settingsput
  • Sheet Config
    • Query Sheetsget
    • Add Sheetpost
    • Delete Sheetdel
    • View Sheetget
    • Patch Sheetpatch
    • Update Sheetput
    • Query Property Sheet Propertiesget
    • Add Property Sheet Propertypost
    • Delete Property Sheet Propertydel
    • View Property Sheet Propertyget
    • Update Property Sheet Propertyput
  • Survey Config
    • Query Surveysget
    • Add Surveypost
    • Delete Surveydel
    • View Surveyget
    • Patch Surveypatch
    • Update Surveyput
  • User Role Config
    • Query User Rolesget
    • Add User Rolepost
    • Delete User Roledel
    • View User Roleget
    • Patch User Rolepatch
    • Update User Roleput
  • User Administration
    • Query Usersget
    • Create Userpost
    • List assignable Usersget
    • View Userget
    • Update Userpost
    • Change my passwordpost
  • User Authentication
    • Authenticate credentialspost
    • Query a User's access keysget
    • Edit an access keypost
    • Generate a new access keypost
    • Revoke an access keypost
  • Vote Config
    • Query Votesget
    • Add Votepost
    • Delete Votedel
    • View Voteget
    • Patch Votepatch
    • Update Voteput
  • Wallet Config
    • Query Walletsget
    • Add Walletpost
    • Delete Walletdel
    • View Walletget
    • Patch Walletpatch
    • Update Walletput
Powered by 

Pagination and Sorting

Updated about 1 year ago


Query (GET) Endpoints
Filtering to limit query results
Did this page help you?

Updated about 1 year ago


Query (GET) Endpoints
Filtering to limit query results
Did this page help you?