OctoSolveAjuda

Profissionais

Consulte profissionais, filtre por serviço e percorra páginas pela API pública v1 da OctoSolve.

Profissionais

O recurso /professionals é somente leitura. Ele informa quem atende cada serviço e pode ser usado para montar seletores antes da consulta de disponibilidade.

Campos

CampoTipoDescrição
iduuidIdentificador do profissional
nomestringNome exibido na agenda
registro_profissionalstring ou nullRegistro profissional, quando cadastrado
biostring ou nullApresentação do profissional
foto_urlstring ou nullEndereço da foto
cor_hexstring ou nullCor usada na agenda
ativobooleano ou nullEstado do cadastro
agenda_ativabooleanoIndica se a agenda pode receber marcações
servico_idsuuid[]Serviços vinculados ao profissional

O e-mail do profissional não sai na API. Ele é dado pessoal de funcionário e não é necessário para escolher quem atende um serviço. A resposta entrega somente o que a integração de agenda precisa, reduzindo a circulação desnecessária de dados pessoais.

Endpoints

MétodoCaminhoEscopoResultado
GET/professionalsread ou writeLista paginada
GET/professionals/{id}read ou writeUm profissional

Listar profissionais

FiltroRegra
ativoPadrão true. Use false para listar somente inativos
servico_idTraz somente profissionais vinculados ao serviço
limitDe 1 a 100, padrão 50
cursorValor opaco retornado pela página anterior
curl --request GET \
  --url "https://api.octosolve.com.br/api/v1/professionals?ativo=true&servico_id=33333333-3333-4333-8333-333333333333&limit=50" \
  --header "Authorization: Bearer osk_live_exemplo_ficticio_00000000000000000000000000" \
  --header "Accept: application/json"

Os itens são ordenados por id. Para buscar a próxima página, preserve ativo e servico_id e envie o next_cursor. Cursor reutilizado com filtros diferentes responde 400 invalid_cursor.

O filtro ativo=true não substitui agenda_ativa. Para oferecer um profissional numa página de agendamento, verifique os dois campos e confirme os horários em /availability.

Consultar um profissional

curl --request GET \
  --url "https://api.octosolve.com.br/api/v1/professionals/44444444-4444-4444-8444-444444444444" \
  --header "Authorization: Bearer osk_live_exemplo_ficticio_00000000000000000000000000" \
  --header "Accept: application/json"

Um UUID inexistente ou pertencente a outra conta responde o mesmo 404 not_found.

Receita para Make ou n8n

  1. Receba o servico_id escolhido na etapa anterior.
  2. Faça GET /professionals?ativo=true&servico_id=ID_DO_SERVICO&limit=100.
  3. Use um iterador sobre data e mantenha apenas profissionais com agenda_ativa: true.
  4. Mostre nome, bio e foto_url quando estiverem preenchidos.
  5. Guarde o id escolhido para consultar /availability e criar o agendamento.
  6. Enquanto has_more for true, repita com os mesmos filtros e cursor=next_cursor.

On this page