Get Appointments_External

Este método permite obtener un listado filtrado o paginado de las citas correspondientes a una organización a través de su identificador externo (companyExternalId). Devuelve la información general y de control de cada registro junto con el recuento total de resultados coincidentes, facilitando la búsqueda por estados, identificadores externos de citas y rangos de fechas sin depender de los IDs internos de la base de datos de la plataforma.

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: en el ejemplo de variables de la petición aparece councilTypes, pero actualmente no forma parte de la query enviada por este request, por lo que no interviene en la ejecución mientras no se añada explícitamente a la consulta.

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(
    $companyExternalId: String
    $state: [Int]
    $externalId: String
    $options: OptionsInput
    $fromDate: String
    $toDate: String
) {
    councils(
        companyExternalId: $companyExternalId
        state: $state
        externalId: $externalId
        options: $options
        fromDate: $fromDate
        toDate: $toDate
    ) {
        list {
            id
            name
            observations
            state
            councilType
            creationDate
            dateStart
            dateRealEnd
            dateRealStart
            participants {
                name
                surname
            }
        }
        total
    }
}

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

{
    "companyExternalId": "API_TEST",
    "fromDate": "2026-05-17T00:00:00Z",
    "toDate": "2026-05-19T00:00:00Z",
    "state": [60],
    "externalId": ""
}

3. Ejemplo de comando cURL

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

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"
                        },
                        {
                            "name": "Name of participant",
                            "surname": "Surname of participant"
                        }
                    ]
                }
            ],
            "total": 1
        }
    }
}

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