APIPartes

Listar partes

GET
/parties
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

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/parties"
{  "items": [    {      "id": "pty_abc123",      "type": "person",      "document_number": "string",      "email": "string",      "phone": "string",      "full_name": "string",      "nationality": "string",      "profession": "string",      "marital_status": "string",      "marriage_regime": "string",      "prenuptial_agreement": {},      "birthdate": "2019-08-24T14:15:22Z",      "company_name": "string",      "cep": "string",      "street": "string",      "number": "string",      "complement": "string",      "district": "string",      "city": "string",      "state": "string",      "tenant_id": "string",      "organization_id": "string",      "visibility": "restricted",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "created_by": "string",      "updated_by": "string"    }  ],  "page_info": {    "end_cursor": "string",    "start_cursor": "string",    "has_next_page": true,    "has_previous_page": true  }}
{  "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"}