Saltar al contenido principal
Obtener una Organización
curl --request GET \
  --url http://127.0.0.1:3000/v1/organizations/{organization_id} \
  --header 'Content-Type: <content-type>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legalName": "<string>",
  "parentOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "doingBusinessAs": "<string>",
  "legalDocument": "<string>",
  "status": {
    "status": {
      "description": "<string>",
      "code": "<string>"
    }
  },
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "zipCode": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>"
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Encabezados

​
Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el Access Manager.

​
Content-Type
string
requerido

Tipo de medio del recurso. Debe ser application/json.

​
X-Request-Id
string

Identificador único usado para rastrear y seguir cada solicitud.

Parámetros de ruta

​
organization_id
string
requerido

Identificador único de la organización asociada con el ledger.

Respuesta

Indica que la solicitud se realizó correctamente y que la respuesta contiene los datos esperados.

​
id
string<uuid>

Identificador único de la organización.

​
legalName
string

Nombre legal de la organización.

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

Identificador único de la organización matriz.

​
doingBusinessAs
string | null

Nombre comercial de la organización.

Maximum string length: 256
​
legalDocument
string

Documento legal de la organización.

Maximum string length: 256
​
status
object

Objeto que contiene información sobre el estado.

​
address
object

Objeto que contiene información sobre la dirección de la organización.

​
metadata
object

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 costos, usa 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Marca temporal de creación (UTC).

​
updatedAt
string<date-time>

Marca temporal de la última actualización (UTC).

​
deletedAt
string<date-time> | null

Marca temporal de eliminación lógica, si aplica (UTC).