Get Appointments

Este método permite obtener un listado paginado o filtrado de las citas que cumplan con los criterios de búsqueda especificados. Devuelve la información general y de control de cada registro junto con el recuento total de resultados coincidentes, siendo de gran utilidad para la sincronización de agendas y la generación de reportes consolidados por organización, rango de fechas o estados.

Detalles de la Solicitud

• Método HTTP: POST

• URL PRE: https://api.ovac.pre.councilbox.com/graphql

• URL PRO: https://api.ovac.councilbox.com/graphql

Autenticación

Tipo: API Key**
Header:** x-jwt-token
Ubicación: Header HTTP_
Ejemplo:_ x-jwt-token: eyJhbGciOiJIUzI1NiIsInR5cCI6...

Referencia de la API

Parámetros de Entrada (Variables)

⚠️ Nota sobre councilTypes****: Aunque en algunos ejemplos heredados de variables se incluye el campo councilTypes, este no se encuentra declarado en la firma de la consulta base provista por el backend. Cualquier intento de enviarlo sin modificar la declaración de la query será ignorado de forma silenciosa.

Campos de Respuesta (Payload)

La consulta devuelve un objeto raíz councils compuesto por las siguientes propiedades:

Ejemplos de Código y Peticiones

1. Consulta GraphQL

query Councils(
    $companyId: Int
    $state: [Int]
    $options: OptionsInput
    $fromDate: String
    $toDate: String
) {
    councils(
        companyId: $companyId
        state: $state
        options: $options
        fromDate: $fromDate
        toDate: $toDate
    ) {
        list {
            id
            name
            observations
            state
            councilType
            creationDate
            dateStart
            dateRealEnd
            dateRealStart
            participants {
                name
                surname
            }
            statute {
                    title
                    statuteId
            }            
        }
        total
    }
}

2. Variables de la Petición (JSON Payload)

{
    "companyId": 2191,
    "fromDate": "2026-05-17T00:00Z",
    "toDate": "2026-05-19T00:00Z",
    "state": [60],
}

3. Ejemplo de comando cURL

curl --location "https://api.ovac.pre.councilbox.com/graphql" \
--header "Content-Type: application/json" \
--header "x-jwt-token: {{token}}" \
--data '{"query":"query Councils($companyId: Int, $state: [Int], $options: OptionsInput, $fromDate: String, $toDate: String) { councils (companyId: $companyId, state: $state, options: $options, fromDate: $fromDate, toDate: $toDate ){ list { id name observations state councilType creationDate dateStart dateRealEnd dateRealStart participants { name surname } } total } }","variables":{"companyId":2191,"fromDate":"2026-05-17T00:00Z","toDate":"2026-05-19T00:00Z","state":[60]}}'

4. Respuesta Esperada (200 OK)

{
    "data": {
        "councils": {
            "list": [
                {
                    "id": 64767,
                    "name": "test creación cita",
                    "observations": "opcional",
                    "state": 60,
                    "councilType": 5,
                    "creationDate": "2026-04-23T15:16:10.085Z",
                    "dateStart": "2026-05-18T15:00:00.000Z",
                    "dateRealEnd": "2026-05-18T09:48:53.988Z",
                    "dateRealStart": "2026-05-18T09:48:37.215Z",
                    "participants": [
                        {
                            "name": "Name of participant",
                            "surname": "Surname of participant"
                        }
                    ],
                    "statute": {
                        "id": 64888,
                        "title": "TEST",
                        "statuteId": 4685
                    }
                }
            ],
            "total": 1
        }
    }
}

Nota OpenAPI/Fern: esta operación GraphQL se documenta como /graphql/councils para que Fern pueda mostrarla como operación independiente. La ruta técnica real de ejecución es POST /graphql.