Skip to main content
GET
Ver un cliente

Authorizations

Authorization
string
header
required

Clave del negocio. sk es una clave completa (todo lo que el rol de quien la creó puede dar) y rk una restringida a los permisos que se eligieron al crearla. Solo se usa desde un servidor: un pedido desde un navegador se rechaza con browser_not_allowed.

Headers

Craqui-Version
string

Versión de la API para este pedido (YYYY-MM-DD). Si no la mandas, se usa la versión fijada en la clave cuando se creó.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-12-01"

Path Parameters

id
string
required

El id del cliente (cli_…). Id de un cliente del estudio.

Pattern: ^cli_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example:

"cli_01hzx8m4k2a7d9q3f5w6y8z0bc"

Query Parameters

expand[]
enum<string>[]

active_membership (pide memberships:read) y credit_balance (pide credits:read), uno por parámetro.

Available options:
active_membership,
credit_balance

Response

OK.

Un cliente del estudio. Nunca trae fecha de nacimiento, dirección, documento, datos fiscales, de salud, notas ni contacto de emergencia.

Un cliente deleted (el estudio lo dio de baja) responde solo por id o dentro de un expand, porque una reserva o una cuota vieja sigue apuntando a su id: trae id, status y fechas, con first_name y last_name en null, y nunca email ni phone, con ningún permiso.

id
string
required

Id de un cliente del estudio.

Pattern: ^cli_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example:

"cli_01hzx8m4k2a7d9q3f5w6y8z0bc"

object
string
required
Allowed value: "client"
livemode
boolean
required

false si el objeto es de tu estudio de prueba (claves crq_test_); true con claves crq_live_.

first_name
string | null
required

null en un cliente deleted, o si el estudio no lo cargó.

Example:

"Sofía"

last_name
string | null
required

null en un cliente deleted, o si el estudio no lo cargó.

Example:

"Pérez"

status
enum<string>
required

active, inactive o deleted. Las listas traen solo active e inactive. La lista puede crecer: trata un valor que no conoces como inactivo.

Available options:
active,
inactive,
deleted
home_center_id
string | null
required

La sede habitual del cliente, si el estudio le asignó una.

Pattern: ^ctr_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example:

"ctr_01hzx8m4k2a7d9q3f5w6y8z0bc"

created_at
string<date-time>
required

Cuándo pasó a ser cliente de este estudio.

Example:

"2026-11-05T19:00:00-03:00"

updated_at
string<date-time>
required

Instante en RFC 3339 con el offset del negocio en ese momento.

Example:

"2026-11-05T19:00:00-03:00"

email
string | null

Solo con el permiso clients.pii:read: sin él, el campo no viene (no es null). null si el cliente no tiene email.

phone
string | null

Solo con el permiso clients.pii:read: sin él, el campo no viene. En formato E.164 (+59899123456); null si no tiene teléfono o si no se pudo leer como uno.

Pattern: ^\+[1-9]\d{6,14}$
Example:

"+59899123456"

active_membership
object | null

Solo en GET /v1/clients/{id} con expand[]=active_membership (pide memberships:read): la membresía que tiene ahora (la active; si no hay, la más nueva paused, suspended o pending_payment). null si no tiene ninguna.

credit_balance
object

Solo en GET /v1/clients/{id} con expand[]=credit_balance (pide credits:read).