Saltar al contenido principal
GET
Recuperar una Organización

Encabezados

Content-Type
string

El tipo de medio del recurso. El valor recomendado es application/json.

X-Request-Id
string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Authorization
string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

Parámetros de ruta

id
string<uuid>
requerido

El identificador único de la Organización.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

id
string<uuid>

El identificador único de la Organización.

La razón social de la Organización.

Maximum string length: 256
parentOrganizationId
string<uuid> | null

El identificador único de la Organización matriz.

doingBusinessAs
string | null

El nombre comercial de la Organización.

Maximum string length: 256

Identificación fiscal oficial, número de registro de la empresa u otra identificación legal.

Maximum string length: 256
Ejemplo:

"123456789012345"

status
object

Un objeto que contiene información sobre el estado.

address
object

Un objeto que contiene información sobre la dirección de la Organización.

metadata
object

Un objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un Centro de Costo, use 'costCenter': 'BR_11101997'.

Restricciones: las claves deben tener como máximo 100 caracteres; los valores de cadena de texto, como máximo 2000 caracteres. No se permiten objetos anidados (los valores deben ser cadena de texto, número o booleano), la estructura no puede exceder una profundidad máxima de 10, y se permite un máximo de 100 claves.

createdAt
string<date-time>

Fecha y hora de creación (UTC).

updatedAt
string<date-time>

Fecha y hora de la última actualización (UTC).

deletedAt
string<date-time> | null

Fecha y hora de la eliminación lógica, si aplica (UTC).