members.list
Lista membros e convites pendentes. Retorna os membros da conta atual (com papel e permissões) e os convites ainda válidos.
- Endpoint:
POST https://app.atomiks.com.br/api/v1/members.list(corpo JSON) - Quem pode chamar: administrador da conta
- Escopo da chave:
team:read - Grava dados: não
- Pela chave de API: sim
- Ferramenta MCP:
members_list - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdmembers.list)
Entrada
Sem campos: envie {}.
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {}
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/members.list \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'CLI:
node cli/atomiks.mjs members.list --json '{}'MCP: ferramenta members_list com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"email": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"permissions": {
"type": "object",
"properties": {
"modules": {
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"screens": {
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"channels": {
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"required": [
"modules",
"screens",
"channels"
],
"additionalProperties": false
},
"isOwner": {
"type": "boolean"
},
"imageUrl": {
"type": [
"string",
"null"
]
},
"lastAccessedAt": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string"
},
"stats": {
"type": "object",
"properties": {
"leads": {
"type": "number"
},
"opportunities": {
"type": "number"
},
"activities": {
"type": "number"
},
"activitySeries": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"leads",
"opportunities",
"activities",
"activitySeries"
],
"additionalProperties": false
}
},
"required": [
"userId",
"email",
"name",
"role",
"permissions",
"isOwner",
"imageUrl",
"lastAccessedAt",
"createdAt",
"stats"
],
"additionalProperties": false
}
},
"invites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"admin",
"user"
]
},
"permissions": {
"type": "object",
"properties": {
"modules": {
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"screens": {
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"channels": {
"anyOf": [
{
"type": "string",
"const": "*"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
"required": [
"modules",
"screens",
"channels"
],
"additionalProperties": false
},
"expiresAt": {
"type": "string"
},
"invitedAt": {
"type": "string"
}
},
"required": [
"id",
"email",
"role",
"permissions",
"expiresAt",
"invitedAt"
],
"additionalProperties": false
}
}
},
"required": [
"members",
"invites"
],
"additionalProperties": false
}Erros
{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).