This documentation is incomplete and is subject to change.
Please take note we have simplified all URLs to a single domain: api.getneo.com and removed /api from the path.
Legacy domains will continue to be supported for existing functionality but will be slowly phased out. 403 Forbidden status), please contact us to discuss.If you have specific questions about any of the content or some missing information, please contact support@getneo.com with your questions.Design#
The platform is provided as a set of HTTP web services, designed using RESTful concepts, with minor customisation to typical flow in order to facilitate better and more secure workflows.Due to the structured nature of the data, the API always responds in JSON format unless stated otherwise. Equally, all request bodies are preferred in JSON format, although other standards (i.e., x-www-form-urlencoded) will be accepted, but support is not guaranteed.The modifications that are applied throughout the whole platform are described in this documentation.Environments#
Neo provides a Demo and a Production environment.This documentation shows both possible URLs, but only the Demo environment can be tested here due to CORS protection.Terminology#
Some Neo-specific terms used throughout the documentation have important meaning.A JSON structure sent in a request.
The platform account that is currently being accessed. A user can switch context to work across multiple tenants with a single login.
The currently authenticated user of the platform.
Entity Ids#
Every entity in Neo has a unique identifier in the form of a 22-character alpha-numeric string, which will be referred to as "ids" in this documentation.Example: PJktaIp1jUiGODbklWBIrA
