Skip to main content
Endpoint · GET /tags
Endpoint somente de consulta: devolve informação e não modifica nada. Não é enviado dentro do array actions — é chamado diretamente.
Devolve o catálogo de etiquetas do negócio, em ordem alfabética e paginado por cursor. Exclui as etiquetas apagadas e as etiquetas de sistema que o dashboard cria por padrão. Serve para saber o name exato de uma etiqueta antes de usá-la: as ações assign_label e remove_label identificam cada etiqueta pelo nome, então convém ler o catálogo primeiro em vez de adivinhar o texto. Parâmetros
  • slug — slug do negócio, no path. Case-insensitive, deve coincidir com o negócio do token (obrigatório).
  • search — substring do nome, case-insensitive. Opcional, de 1 a 100 caracteres. O asterisco * funciona como curinga e corresponde a qualquer sequência de caracteres: fact*mx encontra tanto Facturas MX quanto Facturação MX. Os caracteres % e _ são buscados literalmente.
  • cursor — cursor opaco devolvido pela página anterior em next_cursor. Opcional; omiti-lo pede a primeira página. Não reutilizar cursores entre endpoints diferentes: mesmo que o formato seja idêntico, cada endpoint o interpreta sobre o seu próprio conjunto de dados.
  • limit — etiquetas por página. Opcional, inteiro de 1 a 500, padrão 100.
Nenhum parâmetro de query é obrigatório: GET /tags sem query params devolve a primeira página completa.

​
Resposta

  • items — array de etiquetas, cada uma com name e color.
  • next_cursor — cursor da página seguinte, para enviar como ?cursor=. É null quando has_more é false.
  • has_more — indica se há mais resultados depois desta página. Repetir a chamada com o next_cursor até que seja false.

​
Exemplo

Uma leitura simples, sem corpo: pede o catálogo e não muda nada no negócio.
Buscando com o curinga e pedindo uma página menor:
O name devolvido por esta consulta é o que depois se envia na ação.

​
Erros

O catálogo completo está em Erros. Com o nome em mãos, a ação que o consome é Atribuir etiqueta ou Remover etiqueta.