Change Updates

Do not miss any Platform API changes, ever again

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

RSS

Dec 4, 2024

main
1.1.2
Compare

Documentation content has changed

🚨 Breaking API change detected:

Added (28)

  • GET /bookmark/all
  • GET /call/auth
  • GET /profile/business
  • GET /schedule/all
  • GET /schedule/all/times/{provider}
  • GET /scope/account/activities
  • GET /scope/account/analysis
  • GET /scope/account/associates
  • GET /scope/account/calls
  • GET /scope/account/certificate
  • GET /scope/account/challenges
  • GET /scope/account/chart/account/status
  • GET /scope/account/chart/auth
  • GET /scope/account/chat/rooms
  • GET /scope/account/rating
  • GET /scope/account/referral
  • GET /scope/account/referrals
  • GET /scope/account/reports
  • GET /scope/account/sessions
  • GET /scope/account/shared/accounts
  • GET /scope/account/shared/links
  • GET /scope/account/shops
  • GET /scope/account/tickets
  • GET /scope/account/transactions
  • GET /scope/account/trips
  • GET /scope/account/wallet
  • PATCH /scope/auth/devices
  • PATCH /scope/auth/sessions

Modified (38)

  • GET /active/search
    • Query parameters added: page, size
  • GET /active/search/category
    • Query parameters added: page, size
  • GET /active/status/all
    • Query parameters added: page, size
  • GET /admin/profile
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Property modified: profile
  • GET /admin/team/all
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Property modified: admins
  • GET /business/associate/all
    • Query parameters added: page, size
  • [Breaking] GET /call/authentication
    • Path went from /call/auth to /call/authentication (same operationId) [Breaking]
    • [Breaking] Query parameter removed: channel
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • GET /call/history
    • Query parameters added: page, size
  • GET /company/speak_with_serch
    • Query parameters added: page, size
  • GET /guest/shared/links
    • Query parameters added: page, size
  • [Breaking] GET /profile
    • Path went from /profile/business to /profile (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: name, description, address, contact, logo, default_password
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: status, certificate, business_information
  • GET /rating/all
    • Query parameters added: page, size
  • GET /rating/all/bad
    • Query parameters added: page, size
  • GET /rating/all/good
    • Query parameters added: page, size
  • GET /referral/all
    • Query parameters added: page, size
  • [Breaking] GET /scope/account
    • Path went from /profile to /scope/account (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: category, image, gender, status, certificate, rating, more, specializations, phone_info, verification_status, business_information
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: details, active, organization, additional, delete, device, setting, verification, skills, created_at, updated_at, account_created_at, account_updated_at, profile_created_at, profile_updated_at, email_confirmed_at, password_updated_at, last_signed_in, app_rating, phone_information
    • Query parameter added: id
  • [Breaking] GET /scope/account/analysis/more
    • Path went from /scope/platform/account/analysis/more/{year} to /scope/account/analysis/more (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from array[object] to object [Breaking]
      • Properties added: section, demographics, geographics, activities, overview, states, categories, countries
    • [Breaking] Path parameter removed: year
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • [Breaking] GET /scope/account/analysis/more/{year}
    • Path went from /scope/admin to /scope/account/analysis/more/{year} (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from object to array[object] [Breaking]
      • [Breaking] Properties removed: profile, team, activities, auth, structure, mfa, challenges, sessions, analysis
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Property added: AccountScopeMoreAnalysisResponse
    • [Breaking] Query parameter removed: id
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Path parameter added: year
    • Query parameter added: role
  • [Breaking] GET /scope/account/auth
    • Path went from /call/authentication to /scope/account/auth (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from string to object [Breaking]
      • Properties added: method, level, devices, mfa, has_mfa, must_have_mfa
    • Query parameters added: id, page, size
  • [Breaking] GET /scope/account/bookmarks
    • Path went from /bookmark/all to /scope/account/bookmarks (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: name, avatar, user, category, rating, last_signed_in
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: created_at, updated_at
    • Query parameters added: id, page, size
  • [Breaking] GET /scope/account/schedule/times
    • Path went from /schedule/all/times/{provider} to /scope/account/schedule/times (same operationId) [Breaking]
    • [Breaking] Path parameter removed: provider
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameter added: id
  • [Breaking] GET /scope/account/schedules
    • Path went from /schedule/all to /scope/account/schedules (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: label, schedules
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: address, latitude, longitude, status, reason, id, closed_by, closed_at, closed_on_time, created_at, updated_at
    • Query parameters added: id, page, size
  • [Breaking] GET /scope/account/section
    • Path went from /scope/platform/account/section to /scope/account/section (same operationId) [Breaking]
  • [Breaking] GET /scope/account/section/metric
    • Path went from /scope/platform/account/analysis/more to /scope/account/section/metric (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: section, demographics, geographics, activities, overview, states, categories, countries
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: header, count, feature
  • [Breaking] GET /scope/account/section/search
    • Path went from /scope/payment/transaction/search to /scope/account/section/search (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from array[object] to object [Breaking]
      • Properties added: accounts, total, total_pages
    • [Breaking] Query parameter removed: query
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameters added: role, q
  • [Breaking] GET /scope/admin
    • Path went from /scope/platform/account/section/metric to /scope/admin (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • [Breaking] Properties removed: header, count, feature
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Properties added: profile, team, activities, auth, structure, mfa, challenges, sessions, analysis
    • [Breaking] Query parameter removed: role
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameters added: id, page, size
  • GET /scope/admin/chart/account/status
    • Query parameter modified: year
    • Query parameter is no longer required
  • GET /scope/admin/chart/auth
    • Query parameter modified: year
    • Query parameter is no longer required
  • [Breaking] GET /scope/payment/transaction/search
    • Path went from /scope/platform/account/section/search to /scope/payment/transaction/search (same operationId) [Breaking]
    • Response modified: 200
    • Content type modified: */*
      • [Breaking] Property modified: data
      • Type went from object to array[object] [Breaking]
      • [Breaking] Properties removed: accounts, total, total_pages
        • Removing a resource is always breaking unless it was deprecated before [Breaking]
      • Property added: PaymentApiResponseTransactionGroupScopeResponse
    • [Breaking] Query parameters removed: role, q
    • Removing a resource is always breaking unless it was deprecated before [Breaking]
    • Query parameter added: query
  • GET /shop
    • Query parameters added: page, size
  • GET /shop/search
    • Query parameters added: page, size
  • GET /specialty/all
    • Query parameters added: page, size
  • GET /specialty/search
    • Query parameters added: page, size
  • GET /trip/history
    • Query parameters added: page, size
  • GET /trip/invite
    • Query parameters added: page, size
  • GET /trip/search
    • Query parameters added: page, size
  • PATCH /admin/profile/update
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Property modified: profile
  • PATCH /admin/profile/upload
    • Response modified: 200
    • Content type modified: */*
      • Property modified: data
      • Property modified: profile

Preview documentation