Get Organization Users

Esta operación permite consultar la información detallada de los usuarios pertenecientes a una organización y, de manera específica, obtener el listado de las entidades, delegaciones o centros de atención a los que están vinculados. Está especialmente diseñada para conocer el alcance de gestión de los operarios o filtrar de forma directa por su correo electrónico.

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)

La consulta devuelve un objeto contenedor organizationUsers estructurado con la siguiente taxonomía de datos:

Ejemplos de código y peticiones

💡 Nota de Integración: Se ha ajustado la consulta GraphQL de ejemplo para incluir explícitamente el nodo companies y el argumento filters en la firma de ejecución. De este modo, la petición reflejará de forma fidedigna los datos de filtrado de entrada y el listado de centros del payload de respuesta.

1. Consulta GraphQL

query OrganizationUsers(
    $organizationId: Int!, 
    $options: OptionsInput,
    $filters: [FilterInput]
) {
    organizationUsers(
        corporationId: $organizationId, 
        options: $options,
        filters: $filters
    ) {
        list {
            id
            externalId
            name
            surname
            email
            roles
            externalId
            companies {
                id
                externalId
                businessName
            }
        }
        total
    }
}

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

{
    "organizationId": 2191,
    "options": {
        "limit": 100,
        "offset": 0
    },
    "filters": [
        {
            "field": "email",
            "text": "alejandro.maneiro+apiprof@councilbox.com"
        }
    ]
}

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 OrganizationUsers($organizationId: Int!, $options: OptionsInput, $filters: [FilterInput]) { organizationUsers(corporationId: $organizationId, options: $options, filters: $filters) { list { id name surname email roles externalId companies { id externalId businessName } } total } }","variables":{"organizationId":2191,"options":{"limit":100,"offset":0},"filters":[{"field":"email","text":"alejandro.maneiro+apiprof@councilbox.com"}]}}'

4. Respuesta esperada (200 OK)

{
    "data": {
        "organizationUsers": {
            "list": [
                {
                    "id": 3477,
                    "externalId": null,
                    "name": "API",
                    "surname": "PROFESIONAL",
                    "email": "alejandro.maneiro+apiprof@councilbox.com",
                    "roles": "professionalAdmin",
                    "externalId": null,
                    "companies": [
                        {
                            "id": 2191,
                            "externalId": null,
                            "businessName": "TEST API"
                        }
                    ]
                }
            ],
            "total": 1
        }
    }
}

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