curl https://crm.vistum.com.br/api/v1/members \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"members": [
{
"id": "usr_carlos01",
"name": "Carlos Atendente",
"email": "carlos@empresa.com"
},
{
"id": "usr_ana02",
"name": "Ana Costa",
"email": "ana@empresa.com"
}
]
}
Membros
Listar Membros
Lista os membros do workspace. Use para descobrir os nomes válidos que você vai passar em assignedTo ao criar leads.
GET
/
api
/
v1
/
members
curl https://crm.vistum.com.br/api/v1/members \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"members": [
{
"id": "usr_carlos01",
"name": "Carlos Atendente",
"email": "carlos@empresa.com"
},
{
"id": "usr_ana02",
"name": "Ana Costa",
"email": "ana@empresa.com"
}
]
}
Autenticação
string
required
Bearer vg_live_<sua_chave> — API Key com escopo leads:write ou members:read.A mesma chave usada para Criar Lead já funciona aqui: o escopo leads:write também autoriza a leitura de membros.Para que serve
Ao criar um lead, o campoassignedTo recebe o nome completo do atendente responsável e precisa corresponder exatamente (case-insensitive) a um membro do workspace. Este endpoint devolve a lista de membros para você atribuir o lead ao atendente certo sem erro de digitação.
Resposta de sucesso
object[]
Erros
| Código | Causa |
|---|---|
401 Unauthorized | Chave inválida, ausente ou expirada |
403 Forbidden | Chave válida, mas sem o escopo leads:write nem members:read |
429 Too Many Requests | Limite de 120 requisições por minuto (por IP) excedido |
500 Internal Server Error | Falha ao consultar os membros |
curl https://crm.vistum.com.br/api/v1/members \
-H "Authorization: Bearer vg_live_SUA_CHAVE_AQUI"
{
"members": [
{
"id": "usr_carlos01",
"name": "Carlos Atendente",
"email": "carlos@empresa.com"
},
{
"id": "usr_ana02",
"name": "Ana Costa",
"email": "ana@empresa.com"
}
]
}