Skip to main content
GET
/
api
/
v1
/
bancas
List Bancas
curl --request GET \
  --url https://api.example.com/api/v1/bancas
{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Banca Central",
      "code": "BC001",
      "email": "[email protected]",
      "address": "123 Main Street",
      "phone": "+1-234-567-8900",
      "isActive": true,
      "defaultMinBet": 100,
      "globalMaxPerNumber": 5000,
      "salesCutoffMinutes": 1,
      "createdAt": "2024-03-15T10:30:00Z",
      "updatedAt": "2024-03-15T10:30:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "totalPages": 1
  }
}

​
Overview

Retrieves a paginated list of bancas with optional filtering. Results are automatically filtered based on user role and permissions.

​
Authorization

Required: Valid JWT token (all authenticated users)

​
Query Parameters

​
page
number
default:"1"
Page number (must be positive integer)
​
pageSize
number
default:"20"
Number of items per page (1-100)
​
search
string
Search term to filter bancas (2-100 characters). Searches across name, code, email, phone, and address fields.
​
isActive
boolean
Filter by active status

​
Response

​
success
boolean
Indicates if the request was successful
​
data
array
Array of banca objects
​
meta
object
Pagination metadata
{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Banca Central",
      "code": "BC001",
      "email": "[email protected]",
      "address": "123 Main Street",
      "phone": "+1-234-567-8900",
      "isActive": true,
      "defaultMinBet": 100,
      "globalMaxPerNumber": 5000,
      "salesCutoffMinutes": 1,
      "createdAt": "2024-03-15T10:30:00Z",
      "updatedAt": "2024-03-15T10:30:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 1,
    "totalPages": 1
  }
}

​
Notes

  • Results automatically filtered based on user role (see src/api/v1/controllers/banca.controller.ts:29-36)
  • Search performs fuzzy matching across multiple fields
  • Soft-deleted bancas are excluded unless explicitly requested
  • Response includes full-text search capabilities using PostgreSQL trigram indexes

Build docs developers (and LLMs) love

Get started for freeTalk to us