Producto
CLI

Workspaces

plazbot workspace list | use | show: lista tus workspaces, cambia el activo y muestra su configuración

Workspaces

Todos los comandos del CLI trabajan sobre el workspace activo. Si eres miembro de varios, puedes listarlos y cambiar de uno a otro sin volver a iniciar sesión.

Requiere una sesión iniciada con plazbot login. Con plazbot init sin --user-id el CLI no conoce tu usuario y no puede listar workspaces; con variables de entorno, cambia PLAZBOT_WORKSPACE_ID.


workspace list

Lista los workspaces de los que eres miembro: solo los activos, cuya invitación ya aceptaste y de la misma zona de tu sesión.

bash
01plazbot workspace list [--json]

Parámetros

ParámetroFlagRequeridoDescripción
JSON--jsonNoImprime la lista en JSON, con active: true en el workspace activo

Ejemplos

bash
01# Listar tus workspaces (● marca el activo)
02plazbot workspace list
03 
04# Obtenerlos en JSON
05plazbot workspace list --json

Resultado

text
01┌───┬──────────────────┬───────────────┐
02│ │ Workspace │ ID │
03├───┼──────────────────┼───────────────┤
04│ ● │ Mi Empresa │ wok_AbcDef123 │
05├───┼──────────────────┼───────────────┤
06│ │ Cliente Demo │ wok_XyzUvw456 │
07└───┴──────────────────┴───────────────┘
08 Switch with: plazbot workspace use <workspaceId>

Si no tienes workspaces, imprime No workspaces found for this account.

Salida JSON

json
01[
02 { "id": "wok_AbcDef123", "name": "Mi Empresa", "active": true },
03 { "id": "wok_XyzUvw456", "name": "Cliente Demo", "active": false }
04]

workspace use

Cambia el workspace activo. Antes de cambiarlo, comprueba que tienes acceso.

bash
01plazbot workspace use <workspaceId> [--json]

Parámetros

ParámetroFlagRequeridoDescripción
Workspace ID<workspaceId>SíID del workspace (sale en plazbot workspace list)
JSON--jsonNoImprime el resultado en JSON

Ejemplos

bash
01# Cambiar el workspace activo
02plazbot workspace use wok_XyzUvw456
03 
04# Cambiar desde un script
05plazbot workspace use wok_XyzUvw456 --json

Resultado

text
01 Active workspace: Cliente Demo (wok_XyzUvw456)

Salida JSON

json
01{
02 "id": "wok_XyzUvw456",
03 "name": "Cliente Demo",
04 "active": true
05}


workspace show

Muestra la configuración del workspace: etiquetas, fases, pipelines, canales y demás catálogos, con sus IDs. Es el punto de partida para otros comandos: por ejemplo, plazbot contacts update --add-tag necesita el ID de la etiqueta (mot_...) y --stage el de la fase (mos_...).

bash
01plazbot workspace show [sección] [--include-inactive] [-w <workspaceId>] [-z <LA|EU>] [--json]

Sin sección muestra un resumen: nombre, zona horaria, contadores y cuántos elementos tiene cada sección.

SecciónContenido
tagsEtiquetas de contacto (mot_...)
stagesFases del embudo de contactos (mos_...)
statesEstados de contacto
pipelinesPipelines de oportunidades con sus etapas (pip_...)
variablesVariables personalizadas de contacto (ctc_...)
segmentationsSegmentaciones
groupsGrupos de trabajo del equipo
projectsProyectos de tareas
surveysEncuestas de satisfacción
quick-repliesRespuestas rápidas
rulesReglas automáticas
channelsCanales e integraciones (WhatsApp, Instagram, Google…) con su ID (int_...). Nunca muestra tokens ni claves

Parámetros

ParámetroFlagRequeridoDescripción
Sección[sección]NoUna de las secciones de la tabla. Sin sección, el resumen
Incluir inactivos--include-inactiveNoIncluye etiquetas eliminadas y canales inactivos
Workspace-w, --workspace <id>NoOtro de tus workspaces, sin cambiar el activo
Zona-z, --zone <zone>NoLA o EU
JSON--jsonNoEn una sección, imprime { "data": [...], "nextCursor": null }; en el resumen, el objeto

Ejemplos

bash
01# Resumen del workspace activo
02plazbot workspace show
03 
04# Etiquetas con sus IDs
05plazbot workspace show tags
06 
07# Números de WhatsApp y canales conectados, en JSON
08plazbot workspace show channels --json
09 
10# Pipelines de otro workspace
11plazbot workspace show pipelines -w wok_XyzUvw456

Resultado

text
01 Contact tags (3)
02 ────────────────────────────────────────
03┌────────────────────────────┬──────────────┬─────────┐
04│ ID │ Name │ Color │
05├────────────────────────────┼──────────────┼─────────┤
06│ mot_AbcDef123 │ Cliente VIP │ #4ade80 │
07├────────────────────────────┼──────────────┼─────────┤
08│ mot_GhiJkl456 │ Seguimiento │ #c084fc │
09├────────────────────────────┼──────────────┼─────────┤
10│ mot_MnoPqr789 │ Reclamo │ #ef4444 │
11└────────────────────────────┴──────────────┴─────────┘

Salida JSON (resumen)

json
01{
02 "id": "wok_AbcDef123",
03 "name": "Mi Empresa",
04 "timezone": "America/Lima",
05 "timezoneOffset": -5,
06 "contactsCount": 308,
07 "opportunitiesCount": 42,
08 "tasksCount": 9,
09 "isAutomationDisabled": false,
10 "subscription": [],
11 "sections": { "tags": 16, "stages": 6, "pipelines": 2, "channels": 17 }
12}

Errores comunes

MensajeCausaSolución
You do not have access to workspace wok_...No eres miembro, no aceptaste la invitación o el workspace es de otra zonaRevisa tus workspaces con plazbot workspace list
The session comes from environment variables.Las variables de entorno mandan sobre la sesión guardadaCambia PLAZBOT_WORKSPACE_ID
This session has no user attached, so workspaces cannot be listed.La sesión se guardó con plazbot init sin --user-idInicia sesión con plazbot login
You are not signed in.No hay sesiónEjecuta plazbot login
Unknown section "..."workspace show con una sección que no existeUsa una de la tabla de secciones
Workspace wok_... not found in zone LA.workspace show -w con un workspace de otra zonaAgrega -z EU (o LA)

Para trabajar con un workspace de otra zona, inicia sesión en esa zona: plazbot login --zone EU (o LA).

¿Quieres probar la API en vivo? Abre el Playground.