# Contatos, fluxos e outros identificadores

> Onde achar o ID de contato, fluxo, etiqueta, campo, pipeline, etapa, oportunidade, administrador, agente, produto, pedido e disparo, pela API e pela tela.

Endereço: https://docs.nextags.com.br/comecar/identificadores/
Tipo: Conceito

Atualizado em: 26/10/2026

Quase toda chamada da API pede um ID no caminho, como `/contacts/{contact_id}/send/{flow_id}`. Os IDs são números inteiros (o do pedido é texto) e não mudam quando o nome muda. Cada um pode ser achado por uma chamada da própria API e, em vários casos, também na tela da NexTags.

## Como funciona

Em cada tabela, **API** é a chamada que lista ou busca o item e **Tela** é onde o ID aparece no painel da NexTags. Os números de exemplo são os mesmos de todos os guias.

### Contato: `contact_id`

| Onde | Como achar |
|---|---|
| API | [Buscar contato por campo personalizado](https://docs.nextags.com.br/referencia/contatos/buscar-contato-por-campo-personalizado/): `GET /contacts/find_by_custom_field?field_id=phone&value=5511988776655` (ou `field_id=email`). O ID é o `id` de cada contato em `data`. Veja [Encontrar um contato pelo e-mail ou telefone](https://docs.nextags.com.br/guias/buscar-contato-por-campo/). |
| Tela | Na **Caixa de Entrada**, o painel do contato mostra o **ID de contato** para quem tem a permissão **Ver e-mail e telefone dos contatos**. Em **Contatos**, clicar num contato abre a conversa numa aba nova, com o endereço `inbox?acc=<conta>&id=<ID do contato>`. |
| Fluxo | O campo do sistema `{{user_id}}` traz o ID. A [requisição externa](https://docs.nextags.com.br/webhooks/requisicao-externa-no-fluxo/) manda o ID no cabeçalho `X-USER-ID`. |

Exemplo: `123456789`.

### Fluxo: `flow_id`

| Onde | Como achar |
|---|---|
| API | [Listar fluxos](https://docs.nextags.com.br/referencia/fluxos/listar-fluxos/): `GET /accounts/flows` devolve o `id` e o `name` de cada fluxo. |
| Tela | Em **Fluxos**, abra o fluxo: o endereço do editor traz `flow?id=<ID do fluxo>`. No menu ⋮ do fluxo, **Obter Link** mostra os links do fluxo em cada canal, e todos terminam com o ID, como `https://wa.me/5511999990000?text=/1000001`. No editor, **Obter ID da Etapa** da etapa inicial copia o ID do fluxo. |

Exemplo: `1000001`.

### Etiqueta: `tag_id`

| Onde | Como achar |
|---|---|
| API | [Listar etiquetas](https://docs.nextags.com.br/referencia/etiquetas/listar-etiquetas/) (`GET /accounts/tags`) ou [Buscar etiqueta pelo nome](https://docs.nextags.com.br/referencia/etiquetas/buscar-etiqueta-pelo-nome/) (`GET /accounts/tags/name/{tag_name}`). [Criar etiqueta](https://docs.nextags.com.br/referencia/etiquetas/criar-etiqueta/) devolve o `id` da nova. |
| Tela | **Fluxos** › aba **Etiquetas** › menu ⋮ da etiqueta › **Obter ID**: o ID vai para a área de transferência. |

Exemplo: `2001`.

### Campo personalizado: `custom_field_id`

| Onde | Como achar |
|---|---|
| API | [Listar campos personalizados](https://docs.nextags.com.br/referencia/campos-personalizados/listar-campos-personalizados/) (`GET /accounts/custom_fields`) ou [Buscar campo pelo nome](https://docs.nextags.com.br/referencia/campos-personalizados/buscar-campo-pelo-nome/) (`GET /accounts/custom_fields/name/{custom_field_name}`). [Criar campo personalizado](https://docs.nextags.com.br/referencia/campos-personalizados/criar-campo-personalizado/) devolve o `id` do novo. |
| Tela | **Fluxos** › aba **Campo Personalizados** › menu ⋮ do campo › **Obter ID**. |

Exemplo: `3001`.

### Campo do bot: `bot_field_id`

| Onde | Como achar |
|---|---|
| API | Não há uma chamada que liste só os campos do bot. Criar o campo com [Criar campo personalizado](https://docs.nextags.com.br/referencia/campos-personalizados/criar-campo-personalizado/) e `"isBotField": true` devolve o `id`. |
| Tela | **Fluxos** › aba **Campo Personalizados** › seção **Campo Personalizados do Bot** › menu ⋮ do campo › **Obter ID**. |

Exemplo: `3101`.

### Pipeline: `pipeline_id`

| Onde | Como achar |
|---|---|
| API | [Listar pipelines](https://docs.nextags.com.br/referencia/pipelines/listar-pipelines/): `GET /pipelines`. |
| Tela | Em **Pipelines**, abra o pipeline: o endereço traz `board?acc=<conta>&id=<ID do pipeline>`. |

Exemplo: `4001`.

### Etapa do pipeline: `stage_id`

| Onde | Como achar |
|---|---|
| API | [Listar etapas do pipeline](https://docs.nextags.com.br/referencia/pipelines/listar-etapas-do-pipeline/): `GET /pipelines/{pipeline_id}/stages`. A oportunidade traz a etapa em `stage.id`. |
| Tela | O ID da etapa não aparece na tela. |

Exemplo: `4101`.

### Oportunidade: `opportunity_id`

| Onde | Como achar |
|---|---|
| API | [Listar oportunidades](https://docs.nextags.com.br/referencia/pipelines/listar-oportunidades/): `GET /pipelines/{pipeline_id}/opportunities`, com `contact_id` para filtrar por contato. [Criar oportunidade](https://docs.nextags.com.br/referencia/pipelines/criar-oportunidade/) devolve a oportunidade criada. |
| Tela | No cartão aberto, o campo **Número**. No cartão fechado, o número aparece como `#4201` quando **ID da Oportunidade** está ligado nas **Definições** do pipeline, em **Elementos visíveis do cartão**. |

Exemplo: `4201`.

### Comentário da oportunidade: `comment_id`

| Onde | Como achar |
|---|---|
| API | [Listar comentários da oportunidade](https://docs.nextags.com.br/referencia/pipelines/listar-comentarios-da-oportunidade/). [Comentar na oportunidade](https://docs.nextags.com.br/referencia/pipelines/comentar-na-oportunidade/) devolve o comentário com o `id`. |
| Tela | O ID do comentário não aparece na tela. |

Exemplo: `4301`.

### Administrador: `admin_id` e `assigned_admins`

| Onde | Como achar |
|---|---|
| API | [Listar administradores](https://docs.nextags.com.br/referencia/conta/listar-administradores/): `GET /accounts/admins` devolve o `id`, o nome e o e-mail de cada um. |
| Tela | O ID do administrador não aparece na tela. |

Exemplo: `10001`. O mesmo ID vale no `admin_id` da ação `assign_conversation` e na lista `assigned_admins` da oportunidade.

### Equipe

| Onde | Como achar |
|---|---|
| API | [Listar equipes](https://docs.nextags.com.br/referencia/conta/listar-equipes/): `GET /accounts/teams` devolve o `id` e o `name` de cada equipe. |
| Tela | O ID da equipe não aparece na tela. |

### Agente de IA: `agent_id`

| Onde | Como achar |
|---|---|
| API | [Listar agentes de IA](https://docs.nextags.com.br/referencia/agentes-de-ia/listar-agentes-de-ia/): `GET /agents/`. |
| Tela | No **AI Hub**, clique no agente: o endereço do editor traz `agent?acc=<conta>&id=<ID do agente>`. |

Exemplo: `5001`.

### Produto: `product_id`

| Onde | Como achar |
|---|---|
| API | Não há lista de produtos. O ID aparece no `id` de cada item do carrinho (`line_items`), em [Consultar carrinho](https://docs.nextags.com.br/referencia/ecommerce/consultar-carrinho/). |
| Tela | **Ferramentas** › **Ecommerce** › aba **Produtos**: clique no produto, e o endereço traz `product?id=<ID do produto>`. |

Exemplo: `6001`.

### Pedido: `order_id`

| Onde | Como achar |
|---|---|
| API | Não há lista de pedidos. O carrinho do contato traz o `order_id`, em [Consultar carrinho](https://docs.nextags.com.br/referencia/ecommerce/consultar-carrinho/). |
| Tela | Na **Caixa de Entrada**, o painel do contato lista os **Pedidos**; o link de cada um traz `order?acc=<conta>&id=<ID do pedido>`. |
| Fluxo | O campo do sistema `{{order_id}}` traz o ID do pedido. Mande para o seu sistema numa [requisição externa](https://docs.nextags.com.br/webhooks/requisicao-externa-no-fluxo/). |

Exemplo: `PED-1001`. O ID do pedido é texto: mande do jeito que veio.

### Disparo (Broadcast): `broadcast_id`

| Onde | Como achar |
|---|---|
| API | [Listar disparos](https://docs.nextags.com.br/referencia/disparos/listar-disparos/): `GET /broadcasts`. |
| Tela | O ID do Broadcast não aparece na lista de **Broadcasts**. |

Exemplo: `7001`.

### Calendário: `calendar_id`

| Onde | Como achar |
|---|---|
| API | [Listar calendários](https://docs.nextags.com.br/referencia/agenda/listar-calendarios/): `GET /calendars`. |
| Tela | **Ferramentas** › **Gestor de Agendamentos**: clique no calendário, e o endereço traz `calendar?id=<ID do calendário>`. O **Obter Link** do calendário também traz o ID, em `booking/?id=<ID do calendário>`. |

Exemplo: `8001`.

### Modelo da ferramenta Templates: `template_id` e `template_key`

| Onde | Como achar |
|---|---|
| API | Não há lista de modelos. |
| Tela | **Ferramentas** › **Templates** › menu ⋮ do modelo › **Obter Link** copia `…store/template?id=<template_id>&key=<template_key>`. [Instalar modelo na conta](https://docs.nextags.com.br/referencia/fluxos/instalar-modelo-na-conta/) pede os dois. Veja [Templates: copiar conteúdo entre contas](https://help.nextags.com.br/tutoriais/ferramentas/templates/). |

Exemplo: `9001`.

## Quando usar

- Comece pela API quando o seu sistema precisa achar o item sozinho, como o contato que acabou de comprar.
- Use a tela para pegar uma vez os IDs fixos da integração, como o do fluxo de boas-vindas, o da etiqueta de cliente e o do pipeline de vendas, e guarde no seu sistema.
- Os nomes mudam e podem se repetir; os IDs não. Prefira guardar o ID.

## Boas práticas

> **Guarde os IDs fixos na configuração:**
> Fluxo, etiqueta, campo, pipeline e etapa quase nunca mudam. Guarde os IDs na configuração do seu sistema, ao lado da chave (fora do código), em vez de buscar pelo nome a cada chamada.

> **Nomes vão na URL codificados:**
> Ao buscar pelo nome (`/accounts/tags/name/{tag_name}`), codifique o nome para a URL: espaços e acentos viram `%20`, `%C3%A3` e assim por diante. Use `encodeURIComponent` no JavaScript, `urllib.parse.quote` no Python e `rawurlencode` no PHP.