Neos API Documentation

Here, you’ll find clear guides and examples for common workflows, so you can quickly identify the right endpoints for your project.

Getting Started

This section outlines how to create a new subscription for the Partner API in the Neos API Management Developer Portal.

  1. Sign Up
    Begin by signing up for an account in the Developer Portal. Please Note: You will need to agree to our API agreement upon account creation.

  2. Follow Instructions in Confirmation Email
    After signing up, you will receive a confirmation email with additional instructions. Follow the instructions carefully, and click the link to confirm your account.

  3. Log In and Navigate to Products
    Once your account is confirmed, log in to the Developer Portal. Navigate to the Products page and select "Partner API".

  4. Request Subscription
    In the "Partner API" product page, enter a name for your subscription and click "Subscribe". The name you use should reflect your integration name (i.e., "RingCentral").

  5. Approval Process
    Your subscription request will be sent to our team for review. You will receive an email notification once your request is approved.

  6. Access APIs
    Once your subscription has been activated, you can navigate to the APIs page in the Developer Portal and begin testing API calls

Onboarding Steps

  • Discovery → Approval → Development → API Review → Go-Live

  • API Review is mandatory before production access.

  • All new features or updates require review.

Non-Negotiable Standards

  • Test only in staging.

  • Prevent duplicate records.

  • Optimize searches (POST /advancedSearch/search/results).

  • Use PATCH for partial updates; avoid PUT unless replacing the full object.

  • Implement retry/backoff logic and log failures.

  • Protect all data with encryption and role-based access controls.

Support

To contact us with any questions, please see available options on the Support page.

Powered by Azure API Management © Microsoft 2025