Organization companies | Councilbox OVAC API

# 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`.

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

1 query OrganizationCompanies($options: OptionsInput, $organizationId: Int!) {
2     organizationCompanies(options: $options, organizationId: $organizationId) {
3         list {
4             id
5             businessName
6             tin
7         }
8         total
9     }
10 }

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

1 {
2     "options": {
3         "limit": 5,
4         "offset": 0
5     },
6     "organizationId": 2191
7 }

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)

1 {
2     "data": {
3         "organizationCompanies": {
4             "list": [
5                 {
6                     "id": 2191,
7                     "businessName": "TEST API",
8                     "tin": null
9                 }
10             ],
11             "total": 1
12         }
13     }
14 }

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.

Authentication

x-jwt-tokenstring

JWT token obtained from Login.

Request

This endpoint expects an object.

querystringRequired

GraphQL operation

variablesobjectOptional

GraphQL variables

Response

Successful response. GraphQL business errors may be returned inside the JSON errors field while transport status remains HTTP 200.