Organization companies

# Organization Companies (`query`) Esta operación permite listar todas las entidades o empresas vinculadas directamente a una organización raíz (corporació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. ### 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) | Parámetro | Descripción | Requerido | Tipo | | --- | --- | --- | --- | | organizationId | Identificador único de la organización raíz (corporación) en la plataforma. | SI | Integer | | options | Objeto de configuración para la paginación de resultados. | NO | OptionsInput | | options.**limit** | Cantidad máxima de registros a devolver en la página actual (ej. 5). | NO | Integer | | options.**offset** | Número de registros que se omitirán desde el inicio (punto de corte para paginar). | NO | Integer | ### Campos de Respuesta (Payload) La consulta devuelve un objeto contenedor `organizationCompanies` con los datos de paginación y el listado de empresas: | Parámetro | Descripción | Tipo | | --- | --- | --- | | organizationCompanies | Objeto contenedor con el listado y el total de entidades mapeadas. | Objeto | | organizationCompanies.list | Array de objetos con el detalle individual de cada entidad vinculada. | Array | | organizationCompanies.list\[\].**id** | Identificador numérico único de la entidad o empresa en el sistema. | Integer | | organizationCompanies.list\[\].**businessName** | Razón social, nombre comercial o denominación oficial de la entidad. | String | | organizationCompanies.list\[\].**tin** | Número de Identificación Fiscal (NIF/CIF) de la entidad (si no consta, devuelve null). | String | | organizationCompanies.list\[\].**language** | Muestra los idiomas configurados en la organización | String | | organizationCompanies.**total** | Cantidad total absoluta de entidades que pertenecen a la organización. | String | ## Ejemplos de Código y Peticiones ### 1\. Consulta GraphQL ``` graphql query OrganizationCompanies($options: OptionsInput, $organizationId: Int!) { organizationCompanies(options: $options, organizationId: $organizationId) { list { id businessName tin } total } } ``` ### 2\. Variables de la Petición (JSON Payload) ``` json { "options": { "limit": 5, "offset": 0 }, "organizationId": 2191 } ``` ### 3\. Ejemplo de comando cURL ``` bash 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) ``` json { "data": { "organizationCompanies": { "list": [ { "id": 2191, "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`.