Get Appointment Information

Este método permite obtener información detallada y estructurada de una cita a partir de su identificador único (councilId). Devuelve el estado de la convocatoria, el canal de atención, las marcas de tiempo de control, los datos del agente asignado, los datos de los ciudadanos participantes, el trámite asociado y el desglose de los puntos de la agenda (pasos, firmas y documentación recolectada).

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)

Campos de Respuesta (Payload)

1. Datos Generales de la Cita (council)

2. Bloques de Objetos Anidados

Objeto assignedUser (Agente Asignado)

Contiene la información del profesional que gestiona o atenderá la cita.

• id (Int): ID interno del usuario.

• name / surname (String): Nombre y apellidos del agente.

• email (String): Correo corporativo del agente.

• externalId (String): Identificador del agente en los sistemas del cliente.

Array participants (Ciudadanos Convocados)

Listado con los datos identificativos del ciudadano o ciudadanos que asisten.

• name / surname (String): Nombre y apellidos del participante.

• email (String): Destino de las notificaciones.

• dni (String): Documento de identidad.

• idCardType (String): Tipo de documento ("dni", "nie", "nif", "passport", "codiceFiscale", "europeanDocument").

• idCardCountry (String): Código del país emisor (ISO 3166-1 alfa-2).

Objeto statute (Trámite / Procedimiento)

Taxonomía del trámite asociado a la cita.

• id (Int): ID de la instancia del trámite.

• title (String): Nombre comercial o técnico del trámite (ej. “TEST”).

• statuteId (Int): Identificador maestro del procedimiento dentro de la organización.

Array agendas (Puntos de Control y Flujo de Trabajo)

Desglose secuencial de los puntos y acciones que componen la atención.

• id (Int): ID único del punto del orden del día/trámite.

• name (String): Título identificativo del paso (ej. “Escaneo de documentación”).

• attachments (Array): Documentos aportados al punto por el profesional. Si fue subido por el ciudadano, este objeto se devuelve vacío. Contiene:

  • user (Object): Datos del profesional que lo adjuntó (id, name, surname).

  • filename (String): Nombre y extensión del archivo.

  • downloadUrl (String): Enlace directo de descarga.

  • filesize (String): Tamaño del archivo en bytes.

• participants (Array): Tareas e interacciones ejecutadas por los participantes en este punto:

  • type (String): Tipo de acción realizada (SIGNATURE [Firma], BIOMETRIC [Biometría], INTERACTIVE_DOCS [Formulario PDF], SCREEN_CAPTURE [Captura/Escáner de documento]).

  • agendaSignatoriesParticipantsAttachments (Array): Listado de evidencias binarias generadas por el ciudadano en este paso (ej. su DNI escaneado o el PDF interactivo ya firmado), incluyendo su id, filename y la url de acceso al archivo.

Ejemplos de Código y Peticiones

1. Consulta GraphQL

query CouncilInfo($councilId: Int!) {
    council(id: $councilId) {
        state
        councilType
        dateStart
        dateRealStart
        dateEnd
        adminUrl
        noCelebrateComment
        observations
        internalNotes
        comment
        assignedUser {
            id
            name
            surname
            email
            externalId
        }
        participants {
            name
            surname
            email
            dni
            idCardType
            idCardCountry
        }
        statute {
            id
            title
            statuteId
        }
        agendas {
            id
            name
            attachments {
                user {
                    id
                    name
                    surname
                }
                filename
                downloadUrl
                filesize
            }
            participants {
                type
                agendaSignatoriesParticipantsAttachments {
                    id
                    filename
                    url
                }
            }
        }
    }
}

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

{
    "councilId": 64706
}

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 CouncilInfo($councilId: Int!){ council(id: $councilId){ state councilType dateStart dateRealStart dateEnd adminUrl noCelebrateComment observations internalNotes comment assignedUser { id name surname email externalId } participants { name surname email dni idCardType idCardCountry } statute { id title statuteId } agendas { id name attachments { user { id name surname } filename downloadUrl filesize } participants { type agendaSignatoriesParticipantsAttachments { id filename url } } } } }","variables":{"councilId":64706}}'

4. Respuesta Esperada (200 OK)

{
    "data": {
        "council": {
            "state": 60,
            "councilType": 5,
            "dateStart": "2026-04-21T08:00:47.339Z",
            "dateRealStart": "2026-04-21T07:31:23.016Z",
            "dateEnd": "2026-04-21T07:58:12.113Z",
            "adminUrl": "https://apitest.ovac.pre.councilbox.com/company/2191/council/64706/",
            "noCelebrateComment": "",
            "observations": "Observaciones de la cita",
            "internalNotes": "Notas internas del trámite",
            "comment": null,
            "assignedUser": {
                "id": 3477,
                "name": "API",
                "surname": "PROFESIONAL",
                "email": "alejandro.maneiro+apiprof@councilbox.com",
                "externalId": null
            },
            "participants": [
                {
                    "name": "SOY EL PARTICIPANTE",
                    "surname": "TEST",
                    "email": "alejandro.maneiro+participante@councilbox.com",
                    "dni": "77777777B",
                    "idCardType": "dni",
                    "idCardCountry": "ES"
                }
            ],
            "statute": {
                "id": 64888,
                "title": "TEST",
                "statuteId": 4685
            },
            "agendas": [
                {
                    "id": 88520,
                    "name": "Escaneo de documentación",
                    "attachments": [],
                    "participants": [
                        {
                            "type": "SCREEN_CAPTURE",
                            "agendaSignatoriesParticipantsAttachments": [
                                {
                                    "id": 2664,
                                    "filename": "Documento_identificativo.png",
                                    "url": "https://api.ovac.pre.councilbox.com/file/eyJhbGciOiJIUzI1NiIsInR5cCI6... "
                                }
                            ]
                        }
                    ]
                },
                {
                    "id": 88519,
                    "name": "PDF Interactivo",
                    "attachments": [
                        {
                            "user": {
                                "id": 3477,
                                "name": "API",
                                "surname": "PROFESIONAL"
                            },
                            "filename": "formulario_interactivo.pdf",
                            "downloadUrl": "https://api.ovac.pre.councilbox.com/agendaAttachment/42106",
                            "filesize": "3885"
                        }
                    ],
                    "participants": [
                        {
                            "type": "INTERACTIVE_DOCS",
                            "agendaSignatoriesParticipantsAttachments": [
                                {
                                    "id": 2667,
                                    "filename": "formulario_interactivo.pdf",
                                    "url": "https://api.ovac.pre.councilbox.com/file/eyJhbGciOiJIUzI1... "
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    }
}

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