Skip to main content
The 1eye public API is versioned in the request URL. The current API version is:
Production requests use:
Example:

​
Major versions

The version in the URL represents the major API version. Breaking changes require a new major version. For example:
Existing integrations can continue using the version they were built against until they are migrated to a newer version.

​
Breaking changes

Changes that require a new major API version include:
  • Removing an existing field
  • Renaming an existing field
  • Changing a field’s data type
  • Changing the meaning of an existing enum value
  • Changing ID semantics
  • Changing pagination behavior
  • Changing existing filtering behavior in an incompatible way

​
Non-breaking changes

Adding new response fields is considered non-breaking. Clients should ignore response fields they do not recognize. This allows 1eye to extend API responses without requiring a new major version.

​
API Reference

The 1eye API Reference reflects the current public API contract, including:
  • Endpoints
  • Query parameters
  • Response schemas
  • Enums
  • Sortable fields
  • Error responses
  • Authentication
  • Examples
The API implementation and API Reference are kept aligned with the current version.