Backend App Mobile
  1. Contracts
Backend App Mobile
  • Healthcheck
    • Simple Healthcheck
  • App Settings
    • Feedback Negative FAQ
    • Check Update Version
    • Update App Version
    • Generate OAuth Token
    • Force Password Update
    • Check Password Update
    • Enable Feedback
    • Heap Snapshot
    • List FAQs
    • FAQ Feedback
    • Event Firebase
    • Event Firebase - Session
    • File Upload - Block By Contract
  • OS
    • Create
    • Check Anomaly
    • Available Days
    • List
    • Reschedule
    • Cancel
    • Check Status
    • Confirmation
  • Finances
    • Negotiation Parcels
    • Check Trust
    • License Trust
    • List Calls Extract
    • List History Extract
    • Download PDF Extract
    • Generate Invoices
    • Check Negociations
  • Support
    • List Available Condominiuns
    • Check House Viability
    • Check Condominium Viability
    • Support Help
  • Customer
    • Auth
      • Auth
      • Auth Token Verify (Local JWT)
      • Refresh Token
      • Token Generate
      • Token Verify
    • Email
      • Add Email
      • List Emails
      • Email Update
      • Email Delete
    • Phones
      • Phone Add
      • Phone List
      • Phone Update
      • Phone Delete
    • Popup Notifications
      • Show User Popups
      • Read Popup
      • Create user popup
    • Quick Invoice
    • Contract Details
    • Connection Status Has Notices
    • List Contracts
    • Connection Status
    • Generate Login
    • Password Update
    • Password Recovery
    • Referral (Indique um amigo)
    • Enable Collect Calls
    • Tax Notes
    • Phone Details
    • Due Date Availables
    • Change Due date
    • Request Address Change
    • Service Protocol
    • User Verify
    • File Upload
    • Paid Invoices
    • Contract Term
  • Interface
    • Privacy Policy
    • Invoices
    • Banner Blocking
    • Promo
    • Home
    • License Trust
    • Menu
    • Onboardings
    • Profile
    • Payment Methods
    • Terms and Conditions
    • Store
    • Modify Address
    • Payment Flow
    • Phone List
  • Messages
    • List Messages
    • Read a Message
    • Delete a Message
  • Resources
    • Basic Reset
    • Equipments
    • Generate QR Code
  • SVAs
    • SVA Activation Link Provider
    • SVA Activate
    • List SVAS
    • SVA Activation Link
  • Wi-FI
    • Wifi Devices List
    • Update Wifi Configuration
    • Wifi Status (Can or Not)
    • Wifi Configuration (Mocado))
  • Sales Onboarding
    • Verify Pending
    • Confirm Pending
    • Generate Token
    • Verify Token
  • Push Notifications
    • Send Notifications
  • Crypto
    • Encrypt
  • Admin
    • Auth
  • Proxy Integration
    • OS
      • [OK][CD][XB] Anticipate Available Days
      • [OK][CD][XB] Anticipate Confirmation
      • [OK][CD] Request Address Change
      • [OK][CD] List OS
      • [OK][CD] OS Create
      • [OK][CD] Reschedule
      • [OK][CD] Cancel OS
      • [OK][CD] Confirmation OS
      • [OK][CD] Check OS
    • Financials
      • [OK][CD] Billing Dispute (Contestation)
      • [OK][CD] Calls Extract
      • [OK][CD] Check Trust Eligibility
      • [OK][CD] Extract PDF Calls
      • [OK][CD] Fast Access Invoice
      • [OK][CD] Paid Invoice
      • [OK][CD] List Records
      • [OK][CD] Negotiation Parcels
      • [OK][CD] Generate Payment Link
      • [OK][CD] Negotiation Check Eligibility
      • [OK][CD] Confim Negotiation
      • [OK][CD] Tax Notes
    • Contacts
      • E-mails
        • [OK][CD] List E-mails
        • [OK][CD] Add E-mails
        • [OK][CD] Delete E-mails
      • Phones
        • [OK] List Phones
        • [OK][CD] Add Phone
        • [OK][CD] Update Phone
        • [OK][CD] Delete Phone
    • Contracts
      • [OK][CD] List Products (SVAs)
        GET
      • [OK][CD] Get Activation Link Product (SVA)
        GET
      • [OK][CD] List Contracts
        GET
      • [OK][CD] Contracts Details
        GET
      • [OK][CD] Call History
        GET
      • [OK][CD] Enable Collect Calls
        PUT
      • [OK][CD] List Protocols
        GET
      • [OK][CD] Phone Details
        GET
      • [OK][CD] Contract Unlock
        POST
      • [OK][CD] Contract Term
        GET
      • [OK][CD] Connection Status
        GET
      • [OK][CD] Due Date Availables
        GET
      • [OK][CD] Change Due date
        PUT
      • [OK][CD] Contract Plan
        GET
      • [OK][CD] List Devices Wifi
        GET
      • [OK][CD] Update Wifi
        PUT
      • [OK][CD] File Upload Payment
        POST
      • Product Subscribe
        POST
    • Messages
      • [OK][CD] Contact Withdrawal
      • [OK][CD] List Messages
      • [CD][CD] Read a Message
      • [CD][CD] Delete a Message
    • Menus
      • [OK][CD] Menu Support
      • [OK][CD] Menu Plus
    • Customers
      • [OK][CD] Generate Coupon
      • [OK][CD] Check Customer
      • [OK][CD] Password Update
      • [OK][CD] Password Reset
    • Addresses
      • [OK][CD] List Available Condominiuns
      • [OK][CD] Check Condominium Viability
      • [OK][CD] Check House Viability
    • Bookings
      • [OK][CD] Get Booking Availability
    • FAQ
      • [OK][CD] List All FAQs
      • [OK][CD] Feedback FAQ
    • Login
      • [OK][CD] Login
    • Equipaments
      • [OK][CD] Equipments
    • Config
      • [OK][CD] Check App Version
      • [OK][CD] Token Generate
      • [OK][CD] Token Confirm
      • Token Generate Recovery Password
    • Cards
      • [OK][CD] List Cards (Atalhos)
    • Sales
      • [OK][CD] Verify Pending
      • [OK][CD] Confirm Pending
      • [OK][CD] Generate Token
      • [OK][CD] Confirm Token
    • Massive Warnings
      • [OK][CD] Massive Warnings
    • Parameter
      • [OK][CD] Get parameters (force-password-update)
    • Password Update
      • [OK][CD] Password Update (se deve alterar ou não a senha)
    • Banners
      • [OK][CD] List Banners Home
      • [OK] List Warning Banners
    • Products
      • Eligibility for Product Exchange
      • Products Recommendation
  1. Contracts

[OK][CD] List Contracts

Developing
HML
HML
GET
{{BASE_ENDPOINT}}/app/v1/contracts

Request

Header Params
Authorization
string 
optional
Example:
{{Authorization}}}
apiKey
string 
optional
Example:
{{apiKey}}

Responses

🟢200Success
application/json
Body
object {0}
Example
{
    "contracts": [
        {
            "id": "751329",
            "number": "751329",
            "pme": false,
            "assigned_at": "2024-03-13",
            "business_model": "B2C",
            "is_suspended": true,
            "status_description": "SUSP_DEBITO",
            "sub_brand": "Giga+ Fibra",
            "install_address": {
                "street": "RUA UBELART",
                "neighborhood": "CENTRO",
                "number": "100",
                "city": "CARMO",
                "uf": "MG",
                "complement": "",
                "regional": "R4",
                "cluster": "RS4.4",
                "cep": "37.235-000",
                "area_code": "CGT"
            },
            "mapped_status_description": "Suspenso por débito",
            "can_access_home": true
        },
        {
            "id": "751318",
            "number": "751318",
            "pme": false,
            "assigned_at": "2024-03-01",
            "business_model": "B2C",
            "is_suspended": true,
            "status_description": "CANCELADO",
            "sub_brand": "Giga+ Fibra",
            "install_address": {
                "street": "AVENIDA JOSÉ HERCULANO",
                "neighborhood": "TRAVESSAO",
                "number": "162",
                "city": "CARAGUATATUBA",
                "uf": "RJ",
                "complement": "",
                "regional": "R4",
                "cluster": "RS4.4",
                "cep": "28.640-000",
                "area_code": "CGT"
            },
            "mapped_status_description": "Cancelado",
            "can_access_home": false
        }
    ],
    "blockClient": false
}
Previous
[OK][CD] Get Activation Link Product (SVA)
Next
[OK][CD] Contracts Details
Built with