Skip to main content
GET
Public List Pendencies
Lists pendencies (occupational exam requests) for your organization, with filters by status, type and employee. See the concept in Exam pendency.

Overview

  • Method: GET
  • Path: /v0/pendency/
  • OperationId: public_list_pendencies_v0_pendency__get
  • Authentication: header x-api-key
The schema panel above is generated from the OpenAPI spec, whose field descriptions are written in Portuguese. The English meaning of every field is in the table below.

Response fields

Each item in data carries the fields below. The pagination cursor block is described in How to use.
schedule_appointment_time is the booked time of the exam at the clinic, not the date the pendency was completed. It comes filled — with a future date, even — on pendencies that are still open, and it may be null on pendencies already completed. To know when a pendency was completed, use concluded_at.
  • concluded_at comes from the history event that moved the pendency to DONE. On a tiny fraction of completed pendencies that event is missing and the value falls back to the pendency’s last update.
  • periodicity and next_exam_date come back null on a large share of PERIODIC pendencies, especially older ones. Here null means missing data, not “no periodicity” — to tell whether a pendency is periodic, use type_exam.

Filters

Every parameter below is a query parameter. To send multiple values, repeat the parameter (e.g. ?status=PENDING&status=SCHEDULED).

Sorting

The order is fixed and not chosen by the client: priority, then the exam deadline (due_date), then sla and finally created_at. It is this stable order that keeps offset pagination from repeating or skipping records between pages.
  • Parameters that are not in this table are silently ignored: the API answers 200 as if the filter had not been sent, not 422. Double-check the spelling before concluding that a filter “does not work”.
  • There is no range filter on dates (creation, deadline or SLA) on this route, and no filter by completion date. To track completions, read concluded_at on each pendency.
  • The ordering uses priority, an internal prioritization field that is not returned in the public response.

Enum fields and translations

Use exactly the enum values as defined by the API. The tables below explain the values accepted in filters and returned in the response.

type_exam

All 15 values can show up in the response. Creation through the public API uses the subset described in Create pendency.

status

ohc_status

Example request

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