API v1 Reference

Getting Started

Neon CRM's REST API supports both GET and POST requests. Results are returned in either JSON or XML format (you choose!). If you're using SOAP, then follow standard conventions for SOAP requests.

If you haven't done it already, you'll want to start by generating an API key.

Once you have a key, you'll want to start making API requests to the server. A basic application follows this structure:

  • Login - Use this request to obtain a SessionID.
  • Send requests - All requests must contain a userSessionID. You may specify a response type (JSON or XML). If you do not, the default response will be in JSON.
  • Logout - Use this request to terminate the connection with the server and close the session.
API v1 Login Flow