Consulte o catálogo de serviços, aplique filtros e percorra páginas pela API pública v1 da OctoSolve.

Serviços

O recurso /services é somente leitura. Ele permite montar catálogos, seletores e páginas de agendamento sem copiar a configuração de serviços para outro sistema.

Campos

Campo	Tipo	Descrição
`id`	uuid	Identificador do serviço
`nome`	string	Nome exibido ao cliente
`descricao`	string ou null	Descrição pública do serviço
`duracao_minutos`	inteiro ou null	Duração configurada
`preco`	número	Preço principal
`preco_original`	número ou null	Preço anterior, quando usado
`preco_online`	número ou null	Preço específico do atendimento online
`categoria`	string ou null	Categoria do serviço
`atendimento_online`	booleano	Indica se a configuração atual usa reunião online
`requer_pagamento_antecipado`	booleano	Indica que a criação precisa passar pelo fluxo de cobrança
`requer_confirmacao_manual`	booleano ou null	Indica confirmação manual
`ativo`	booleano ou null	Estado do serviço

atendimento_online reflete a configuração atual de reunião usada pela agenda.

Endpoints

Método	Caminho	Escopo	Resultado
`GET`	`/services`	`read` ou `write`	Lista paginada
`GET`	`/services/{id}`	`read` ou `write`	Um serviço, inclusive inativo

Listar serviços

Filtro	Regra
`ativo`	Padrão `true`. Use `false` para listar somente inativos
`q`	Busca no nome sem diferenciar maiúsculas e minúsculas, de 2 a 80 caracteres
`limit`	De 1 a 100, padrão 50
`cursor`	Valor opaco retornado pela página anterior

curl --request GET \
  --url "https://api.octosolve.com.br/api/v1/services?ativo=true&q=consulta&limit=50" \
  --header "Authorization: Bearer osk_live_exemplo_ficticio_00000000000000000000000000" \
  --header "Accept: application/json"

Os itens são ordenados por id. Para buscar a página seguinte, mantenha ativo e q iguais e envie o next_cursor recebido. Cursor reaproveitado com filtros diferentes responde 400 invalid_cursor.

Consultar um serviço

curl --request GET \
  --url "https://api.octosolve.com.br/api/v1/services/33333333-3333-4333-8333-333333333333" \
  --header "Authorization: Bearer osk_live_exemplo_ficticio_00000000000000000000000000" \
  --header "Accept: application/json"

A consulta por id também devolve serviço inativo. Isso permite resolver o servico_id de um agendamento antigo. Um UUID inexistente ou de outra conta responde o mesmo 404 not_found.

Receita para Make ou n8n

Faça GET /services?ativo=true&limit=100 com uma chave read ou write.
Use um iterador sobre data para preencher seu catálogo ou seletor.
Para uma página de agendamento pela API, descarte itens com requer_pagamento_antecipado: true, pois o POST /appointments recusa esse fluxo.
Guarde id, nome, duracao_minutos, preco e atendimento_online no item escolhido.
Enquanto has_more for true, repita a chamada com os mesmos filtros e com cursor=next_cursor.
Se receber invalid_cursor, descarte o cursor e reinicie desde a primeira página.

Serviços

Serviços

Campos

Endpoints

Listar serviços

Consultar um serviço

Receita para Make ou n8n

On this page