List all contracts

GET

/api/contract

List all contracts.

Requisição

Authorization

Parâmetros de Consulta

Respostas

🟢200OK

application/json

Success

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/contract?number&customer_id&billing_customer_id&agent_id&city_id&signature_date&approval_date&start_date&end_date&suspension_date&cancellation_date&contract_status&contract_stage&status&name&city_name&flags&customer_flags&limit&page'

Response Example

{
    "data": [
        {
            "id": "404276b7-a682-4736-b7ae-123d82c8dd0d",
            "number": "CTR001",
            "customer_id": "cf3388d2-82df-4f94-8704-4db0f78abf28",
            "billing_customer_id": "cf3388d2-82df-4f94-8704-4db0f78abf28",
            "agent_id": "18bfca62-e884-4274-8358-3810708751df",
            "sinature_date": "2024-12-25",
            "approval_date": "2024-12-25",
            "start_date": "2024-12-26",
            "end_date": null,
            "suspension_date": null,
            "cancellation_date": null,
            "address_id": "b2447ad1-76d0-49a8-9537-a7dcd2dfb817",
            "total_value": 500,
            "contract_status": "ACTIVE",
            "contract_stage": "INSTALLED",
            "status": true
        }
    ],
    "page": {
        "totalItems": 1,
        "totalPages": 1,
        "limit": 100,
        "page": 1
    }
}

Modificado em 2025-12-12 13:31:22

Página anterior

Associate classification flags with a product

Próxima página

Create a new contract