GET /v1/users
GET
/v1/users
const url = 'https://seu-endereco-da-api/v1/users';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://seu-endereco-da-api/v1/users \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler usuários (users:read), ou Ler conversas (conversations:read), ou Gerenciar fluxos (flows:manage), ou Gerenciar agentes de IA (agents:manage), ou Gerenciar sequências (sequences:manage), ou Gerenciar disparos automáticos (automations:manage).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”cursor
string
limit
string
Responses
Seção intitulada “Responses”Media typeapplication/json
Array<object>
object
id
required
string
email
required
string
name
required
string
status
required
string
roleAdjustedAt
required
Set when the move to one role per person picked this user’s role; cleared on the next role change
string format: date-time
avatarUrl
required
Public url for the user’s photo
string
maxOpenConversations
required
Ceiling of simultaneous open conversations, null when unlimited
number
openAssigned
Open conversations currently assigned to this user; only on GET /users/:id
number
createdAt
required
string format: date-time
invite
required
Null for people who were not invited by e-mail
object
sentAt
required
When the last invite e-mail left; null while it is on its way
string format: date-time
acceptedAt
required
First time the person entered
string format: date-time
departments
required
Array<object>
object
id
required
string
name
required
string
color
required
string
roles
required
Array<object>
object
id
required
string
name
required
string
channels
required
Channels this user answers
Array<object>
object
id
required
string
name
required
string
quickReplies
required
Array<object>
object
id
required
string
title
required
string
content
required
string
shortcut
required
string
Example generated
[ { "id": "example", "email": "example", "name": "example", "status": "example", "roleAdjustedAt": "2026-04-15T12:00:00Z", "avatarUrl": "example", "maxOpenConversations": 1, "openAssigned": 1, "createdAt": "2026-04-15T12:00:00Z", "invite": { "sentAt": "2026-04-15T12:00:00Z", "acceptedAt": "2026-04-15T12:00:00Z" }, "departments": [ { "id": "example", "name": "example", "color": "example" } ], "roles": [ { "id": "example", "name": "example" } ], "channels": [ { "id": "example", "name": "example" } ], "quickReplies": [ { "id": "example", "title": "example", "content": "example", "shortcut": "example" } ] }]