Skip to main content
GET
Public List Pendencies
Lista pendências (solicitações de exame ocupacional) da organização, com filtros por status, tipo e colaborador. Veja o conceito em Pendência (Exame).

Visão Geral

  • Método: GET
  • Path: /v0/pendency/
  • OperationId: public_list_pendencies_v0_pendency__get
  • Autenticação: header x-api-key

Campos da resposta

Cada item de data traz os campos abaixo. O bloco cursor da paginação está descrito em Como usar.
schedule_appointment_time é o horário marcado do exame na clínica, não a data em que a pendência foi concluída. Ele aparece preenchido — inclusive com data no futuro — em pendências ainda abertas, e pode vir null em pendências já concluídas. Para saber quando a pendência foi concluída, use concluded_at.
  • concluded_at vem do evento de histórico que levou a pendência para DONE. Numa fração mínima das concluídas esse evento não existe e o valor cai para a data da última atualização da pendência.
  • periodicity e next_exam_date vêm null em boa parte das pendências PERIODIC, sobretudo nas mais antigas. null aqui significa dado ausente, não “sem periodicidade” — para saber se a pendência é periódica, use type_exam.

Filtros

Todos os parâmetros abaixo são de query. Para enviar vários valores, repita o parâmetro (ex.: ?status=PENDING&status=SCHEDULED).

Ordenação

A ordem é fixa e não é escolhida pelo cliente: prioridade, depois prazo do exame (due_date), depois sla e, por fim, created_at. É essa ordem estável que faz a paginação por offset não repetir nem pular registros entre páginas.
  • Parâmetros que não estão nesta tabela são ignorados em silêncio: a API responde 200 como se o filtro não tivesse sido enviado, e não 422. Confira a grafia antes de concluir que um filtro “não funciona”.
  • Não existe filtro por intervalo de datas (criação, prazo ou SLA) nesta rota, nem filtro por data de conclusão. Para acompanhar conclusões, leia concluded_at de cada pendência.
  • A ordenação usa priority, um campo interno de priorização que não é devolvido na resposta pública.

Campos enum e traduções

Use exatamente os valores do enum conforme definidos pela API. As tabelas abaixo explicam os valores aceitos nos filtros e devolvidos na resposta.

type_exam

Os 15 valores podem aparecer na resposta. A criação pela API pública usa o subconjunto descrito em Criar pendência.

status

ohc_status

Exemplo de requisição

Authorizations

x-api-key
string
header
required

Query Parameters

is_active
default:true

Filtra solicitações ativas.

page
integer
default:0

Página, começando em 0.

Required range: x >= 0
limit
integer
default:20

Itens por página. Máximo de 500.

Required range: 1 <= x <= 500
id
string<uuid>[] | null

Filtra por identificadores de solicitação. Repetível.

status
enum<string>[] | null

Filtra por etapa operacional da solicitação. Repetível.

Available options:
ON_HOLD,
PENDING,
PRE_SCHEDULED,
SCHEDULED,
DONE,
CANCELED,
ABSENT,
MISSING_OHC,
NO_RESPONSE
type_exam
enum<string>[] | null

Filtra por tipo de exame ocupacional. Repetível.

Available options:
HIRING,
DISMISSAL,
PERIODIC,
RETURN,
RISK_CHANGE,
INTERN_HIRING,
PUNCTUAL,
CRITICAL_ACTIVITY,
APPOINTMENT,
APPOINTMENT_RETURN,
MEDICAL_LEAVE,
INFIRMARY,
THIRD_PARTY,
ANAMNESE,
EMPLOYEE_ACTION
organization_id
string<uuid>[] | null

Filtra por empresa. Repetível. Quando omitido, devolve as empresas autorizadas para a chave de API.

employee_id
string<uuid> | null

Filtra pelas solicitações de um colaborador.

employee__admission_date
string<date> | null

Filtra colaboradores admitidos exatamente nesta data (AAAA-MM-DD), conforme o cadastro atual.

employee__dismissal_date
string<date> | null

Filtra colaboradores desligados exatamente nesta data (AAAA-MM-DD), conforme o cadastro atual.

Response

Successful Response

data
PublicApiPendencyBaseResponse · object[]
required
cursor
PaginateCursor · object | null
required