Skip to main content
GET
Listar clientes
Returns a paginated list of customers. Results cover the whole company, not just the project your token belongs to — see Tenancy is implicit.

Endpoint

Required scope

crm:customers:read

Headers

Query parameters

Example request

Response

200 OK

400 Bad Request

limit above 200, negative offset, or an unknown query parameter.

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the crm:customers:read scope.

Operational notes

  • Search is a contains match, not fuzzy. perez matches Pérez and Perezoso; it does not match a typo like peres.
  • phone is exact, including the + and country code. Store phones in E.164 if you plan to look them up.
  • To page through the full set, increment offset by limit until offset >= total.

Authorizations

Authorization
string
header
required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Query Parameters

Búsqueda libre por nombre o email

phone
string

Filtrar por teléfono exacto

limit
number
default:50
Required range: 1 <= x <= 200
offset
number
default:0
Required range: x >= 0

Response

200 - application/json
data
object[]
required
total
number
required
limit
number
required
offset
number
required