Get Organization Companies

Esta operación permite listar todas las entidades vinculadas directamente a una organización. Incluye soporte nativo para paginación a través de un objeto de opciones, lo que permite segmentar y limitar el volumen de registros devueltos en ecosistemas corporativos grandes.

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 organizationCompanies con los datos de paginación y el listado de empresas:

Ejemplos de Código y Peticiones

1. Consulta GraphQL

query OrganizationCompanies($options: OptionsInput, $organizationId: Int!) {
    organizationCompanies(options: $options, organizationId: $organizationId) {
        list {
            id
            externalId
            businessName
            tin
        }
        total
    }
}

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

{
    "options": {
        "limit": 5,
        "offset": 0
    },
    "organizationId": 2191
}

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 OrganizationCompanies($options: OptionsInput, $organizationId: Int!){ organizationCompanies(options: $options, organizationId: $organizationId){ list{ id businessName tin } total } }","variables":{"options":{"limit":5,"offset":0},"organizationId":2191}}'

4. Respuesta Esperada (200 OK)

{
    "data": {
        "organizationCompanies": {
            "list": [
                {
                    "id": 2191,
                    "externalId": null,
                    "businessName": "TEST API",
                    "tin": null
                }
            ],
            "total": 1
        }
    }
}

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