Change Updates

Do not miss any Mahjoz API changes, ever again

Subscribe to the Mahjoz API changelog to be up to date on recent changes.

RSS

Sep 8, 2025

main
1.0.0
Compare

API structure has changed

4 structure changes including:
2 Breaking changes
1 Modification
3 Removals
Modified 1 Breaking
GET /api/customers
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • id property Modified
          • Removing polymorphism is always breaking
            Breaking
        • first_name, last_name, phone, address properties Modified
          • Type went from string | null to string
            Breaking
        • email property Modified
          • Type went from string(email) | null to string(email)
            Breaking
      • meta property Modified
        • current_page, from, last_page, links, path, per_page, to, total properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • next_cursor, prev_cursor properties Added
      • links property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • 401, 403, 429 responses Added
  • Query
  • page query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Authentication
  • O auth2 client credentials authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Header
  • X-Api-Key header Added
Removed 3 Breaking
O auth2 client credentialsauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /customers
POST /api/v1/token-generate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking