Misakey API Documentation

Welcome to our API documentation.

Remark: most of the API is described by examples more than by rigorous formal specification. For instance when you see a UUID somewhere, you should understand that the value at this location must be an UUID, not that it must be this exact UUID (which wouldn’t make sense anyway).

Global rules:

• All time strings are represented following the RFC 3339, ex 2038-11-05T00:00:00.000Z.
• All request and response parameters described in following specifications are required or always returned, unless other rules are locally specified.

Concepts

Pages not describing API endpoints but concepts used accross several endpoints.

• Storage quota
• Realtime
• Argon2 Server Relief
• Authorization & Authentication
• Box Events
• Encryption Algorithms
• Formatting of errors
• HTTP Query Parameters Formats
• Identity Public Keys
• Pagination

Endpoints

Pages documenting API endpoints, grouped by topic.

• Webauthn Configuration
• Box Users
• Datatag
• Generic
• Identities
• Storage quota
• Box Realtime
• Accounts
• Auth Flow
• Backup Archives
• Backup Key Shares
• Box Events
• Box Key Shares
• Boxes
• Coupons
• Crypto Actions
• Files Upload & Download
• Saved Files
• SSO - Accounts
• Organizations
• TOTP Configuration