Documentação

ReferênciaNegócios

Listar negócios

GET
/deals
X-API-Key<token>

Chave de API (prefixo nbr_) ou Token de Acesso Pessoal (prefixo pat_)

In: header

Query Parameters

cursor?string

Token opaco de cursor para paginação. Obtido via page_info.end_cursor da resposta anterior.

limit?integer

Número de itens por página.

Range1 <= value <= 100
Default25
stage_id?string
status?string

Value in

  • "aberto"
  • "ganho"
  • "perdido"
owner_user_id?string
purpose?string

Value in

  • "compra"
  • "locacao"
party_id?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/deals"
{  "items": [    {      "id": "del_abc123",      "party_id": "string",      "purpose": "compra",      "stage_id": "string",      "status": "aberto",      "lost_reason": "string",      "won_at": "2019-08-24T14:15:22Z",      "lost_at": "2019-08-24T14:15:22Z",      "owner_user_id": "string",      "source_lead_id": "string",      "value_cents": 0,      "custom_fields": {},      "search_profile": {        "property_types": [          "apartment"        ],        "cities": [          "string"        ],        "districts": [          "string"        ],        "price_min": 0,        "price_max": 0,        "bedrooms_min": 0,        "area_min": 1,        "notes": "string"      },      "property_ids": [        "string"      ],      "proposal_ids": [        "string"      ],      "proposals": [        {          "id": "string",          "proposal_number": "string",          "status": "string"        }      ],      "contact_name": "string",      "contact_phone": "string",      "owner_user_name": "string",      "tenant_id": "string",      "organization_id": "string",      "visibility": "restricted",      "created_by": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_by": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page_info": {    "end_cursor": "string",    "start_cursor": "string",    "has_next_page": true,    "has_previous_page": true  }}
{  "type": "validation",  "title": "Validation Failed",  "status": 400,  "detail": "name is required",  "code": "validation.required",  "instance": "/public/v1/brokers",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/validation",  "errors": [    {      "field": "name",      "message": "name is required",      "code": "validation.broker.name_required"    }  ]}
{  "type": "unauthorized",  "title": "Authentication Required",  "status": 401,  "detail": "authentication required",  "code": "unauthorized.auth_required",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/unauthorized"}
{  "type": "forbidden",  "title": "Access Denied",  "status": 403,  "detail": "insufficient permissions",  "code": "forbidden.insufficient_permissions",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/forbidden"}
{  "type": "rate_limit",  "title": "Rate Limit Exceeded",  "status": 429,  "detail": "rate limit exceeded",  "code": "rate_limit.exceeded",  "retry_after": 60,  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/rate-limit"}
{  "type": "internal",  "title": "Internal Server Error",  "status": 500,  "detail": "an unexpected error occurred",  "code": "internal.unexpected",  "request_id": "req_abc123",  "timestamp": "2026-02-15T12:00:00Z",  "documentation_url": "https://docs.nobur.com.br/errors/internal"}