Skip to content

Support

Need help with the Nymbl API? We're here to assist you.

Getting Help

Documentation

Before reaching out, check our comprehensive documentation:

Contact Support

For technical support or questions:

Common Issues

Authentication Problems

Problem: Getting 401 Unauthorized errors

Solutions: - Verify your access token is not expired (tokens last 5 minutes) - Check that you're using Bearer token authentication - Verify the x-api-key header is present and correct - Ensure your client credentials are correct - Verify you're using the correct scope for your customer account

See Authentication Troubleshooting for more details.

Query Errors

Problem: Getting 400 Bad Request on queries

Solutions: - Verify query syntax follows OData v4 conventions - Check that property names match the schema - Ensure filters use single quotes for string values - URL encode special characters in query parameters

See OData Query Guide for syntax reference.

Rate Limiting

Problem: Requests are being throttled

Solutions: - Reduce request frequency - Implement exponential backoff - Use $top to retrieve fewer records per request - Cache responses when appropriate

Feature Requests

Have an idea for improving the API? We'd love to hear from you!

Contact your account manager to discuss:

  • New endpoint requirements
  • Additional query capabilities
  • Integration features
  • Custom reporting needs

API Status

To check the current status of the API:

  • Monitor your application's error rates
  • Check for service announcements from your account manager

Reporting Issues

When reporting an issue, please include:

  1. Timestamp: When the issue occurred
  2. Request Details: URL, headers, and body
  3. Response: Status code and error message
  4. Environment: Which API endpoint you're using
  5. Customer: Your customer identifier

Example Issue Report:

Timestamp: 2024-02-17T10:30:00Z
Request: GET /Patients?$filter=invalid_field eq 'value'
Response: 400 Bad Request
Error: Property 'invalid_field' does not exist on type 'Patient'
Environment: https://api.nymbldev.com
Customer: demo-customer

Frequently Asked Questions

How often do access tokens expire?

Access tokens expire after 5 minutes. Your application should cache tokens and request new ones before expiration.

What's the maximum number of records I can retrieve?

The maximum page size is 100 records. Use $top and $skip to paginate through larger datasets.

Can I use PATCH to update records?

No, only PUT is supported for updates. You must provide all required fields in the request body.

Can I delete records?

No, DELETE operations are not supported. Contact your account manager if you need records removed.

Maximum expand depth is 3 levels. For example: Patients -> Appointments -> Physician is allowed.

Are there sandbox/test environments?

Yes, contact your account manager to request access to development and QA environments.

SDK and Libraries

Currently, we don't provide official SDKs. However, you can:

  • Use any OData v4 client library
  • Generate a client from the OpenAPI specification (/openapi.json)
  • Use standard HTTP libraries (requests, axios, etc.)

Popular OData client libraries:

Terms of Service

Usage of the API is subject to your service agreement with Nymbl. Please contact your account manager for:

  • Service level agreements
  • Data usage policies
  • Compliance requirements
  • Security standards