attendants.availability_get
Ver a disponibilidade semanal de um atendente. Fuso e faixas de horário por dia da semana (dayOfWeek 0 = domingo a 6 = sábado, startTime/endTime em HH:mm). Sem disponibilidade gravada (ou sem a migration), timezone vem null e slots vazio.
- Endpoint:
POST https://app.atomiks.com.br/api/v1/attendants.availability_get(corpo JSON) - Quem pode chamar: membro da conta
- Escopo da chave:
crm:read - Grava dados: não
- Pela chave de API: sim
- Ferramenta MCP:
attendants_availability_get - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdattendants.availability_get)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
id | string (uuid) | sim |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"id"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/attendants.availability_get \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"id":"00000000-0000-0000-0000-000000000000"}'CLI:
node cli/atomiks.mjs attendants.availability_get --json '{"id":"00000000-0000-0000-0000-000000000000"}'MCP: ferramenta attendants_availability_get com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"attendantId": {
"type": "string"
},
"timezone": {
"type": [
"string",
"null"
]
},
"slots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dayOfWeek": {
"type": "integer",
"minimum": 0,
"maximum": 6
},
"startTime": {
"type": "string",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
},
"endTime": {
"type": "string",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
}
},
"required": [
"dayOfWeek",
"startTime",
"endTime"
],
"additionalProperties": false
}
}
},
"required": [
"attendantId",
"timezone",
"slots"
],
"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).