Estás en: Documentación › Gestión › Obtener un cliente
Obtener un cliente
Parámetros que acepta este endpoint y campos que devuelve.
GET
/v1/customers/{id}Permiso necesario en la clave: customers:read (o *).
Parámetros de ruta
| Nombre | Tipo | Obligatorio | Qué es | Ejemplo |
|---|---|---|---|---|
{id} | número entero | Sí | Identificador numérico del registro, el campo «id» que devuelve el listado. | 32 |
Parámetros de consulta
Este endpoint no admite filtros.
Campos de la respuesta
| Campo | Tipo | Qué contiene |
|---|---|---|
id | número entero | Identificador interno del cliente. |
code | texto | Código de cliente. |
name | texto | Nombre o razón social. |
alias | texto | Nombre comercial, si lo hay. |
tax_id | texto | NIF / CIF. |
type | texto (lista) | customer, prospect, customer_prospect u other. |
address | texto | Dirección. |
zip | texto | Código postal. |
town | texto | Población. |
country | texto | País (código ISO). |
phone | texto | Teléfono. |
email | texto | Correo electrónico. |
active | sí / no | true si el cliente está activo. |
created_at | fecha y hora ISO 8601 | Alta. Fecha y hora ISO 8601 en UTC. |
updated_at | fecha y hora ISO 8601 | Última modificación. Fecha y hora ISO 8601 en UTC. |