Skip to main content
Endpoint · GET /tags
Endpoint de solo consulta: devuelve información y no modifica nada. No se manda dentro del array actions — se llama directo.
Devuelve el catálogo de etiquetas del negocio, en orden alfabético y paginado por cursor. Excluye las etiquetas borradas y las etiquetas de sistema que el dashboard crea por defecto. Sirve para saber el name exacto de una etiqueta antes de usarla: las acciones assign_label y remove_label identifican cada etiqueta por nombre, así que conviene leer el catálogo primero en vez de adivinar el texto. Parámetros
  • slug — slug del negocio, en el path. Case-insensitive, debe coincidir con el negocio del token (obligatorio).
  • search — substring del nombre, case-insensitive. Opcional, de 1 a 100 caracteres. El asterisco * funciona como comodín y coincide con cualquier secuencia de caracteres: fact*mx encuentra tanto Facturas MX como Facturación MX. Los caracteres % y _ se buscan literalmente.
  • cursor — cursor opaco devuelto por la página anterior en next_cursor. Opcional; omitirlo pide la primera página. No reutilizar cursores entre endpoints distintos: aunque el formato sea idéntico, cada endpoint lo interpreta sobre su propio conjunto de datos.
  • limit — etiquetas por página. Opcional, entero de 1 a 500, por defecto 100.
Ningún parámetro de query es obligatorio: GET /tags sin query params devuelve la primera página completa.

Respuesta

  • items — arreglo de etiquetas, cada una con name y color.
  • next_cursor — cursor de la página siguiente, para pasarlo como ?cursor=. Es null cuando has_more es false.
  • has_more — indica si hay más resultados después de esta página. Repetir la llamada con el next_cursor hasta que sea false.

Ejemplo

Una lectura simple, sin cuerpo: pide el catálogo y no cambia nada en el negocio.
Buscando por comodín y pidiendo una página más chica:
El name que devuelve esta consulta es el que después se manda en la acción.

Errores

El catálogo completo está en Errores. Con el nombre en la mano, la acción que lo consume es Asignar etiqueta o Quitar etiqueta.