Obtener Organización por ID

Obtén los detalles completos de una organización específica.

Endpoint

GET https://api.lummy.io/v1/organizations/{id}

Entorno	URL
Producción	https://api.lummy.io/v1/organizations/{id}
Sandbox	https://sandbox.lummy.io/v1/organizations/{id}

Path Parameters

Path Parameters

{

"id": stringrequerido

↳Identificador único de la organización en formato UUID. Este identificador se obtiene al crear la organización o mediante el endpoint de listado de organizaciones.

↳Formato: uuid

↳Ejemplo: "550e8400-e29b-41d4-a716-446655440000"

}

Headers

Headers

{

"Authorization": stringrequerido

↳Token de autenticación en formato Bearer (JWT) que valida la identidad del usuario. Este token debe ser enviado en cada petición para acceder a los recursos protegidos de la API.

↳Ejemplo: "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

}

Ejemplos de Código

cURL

curl -X GET "https://sandbox.lummy.io/organizations/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}"

Node.js (TypeScript)

import axios from 'axios';

interface Organization {
  id: string;
  name: string;
  legalName: string;
  rfc: string;
  taxRegime: string;
  zipCode: string;
  isActive: boolean;
  createdAt: string;
  updatedAt: string;
}

async function obtenerOrganizacion(organizationId: string): Promise<Organization> {
  const API_URL = `https://sandbox.lummy.io/organizations/${organizationId}`;
  const ACCESS_TOKEN = process.env.ACCESS_TOKEN!;

  try {
    const response = await axios.get<Organization>(API_URL, {
      headers: {
        'Authorization': `Bearer ${ACCESS_TOKEN}`,
      },
    });

    console.log('Organizacion obtenida:');
    console.log(`Nombre: ${response.data.name}`);
    console.log(`RFC: ${response.data.rfc}`);
    console.log(`Régimen: ${response.data.taxRegime}`);
    console.log(`Activo: ${response.data.isActive ? 'Sí' : 'No'}`);

    return response.data;
  } catch (error) {
    console.error('Error al obtener organizacion:', error);
    throw error;
  }
}

// Ejecutar
obtenerOrganizacion('550e8400-e29b-41d4-a716-446655440000');

Dependencias

npm install axios

Python

import os
import requests

def obtener_organizacion(organization_id: str):
    api_url = f"https://sandbox.lummy.io/organizations/{organization_id}"
    access_token = os.getenv("ACCESS_TOKEN")

    if not access_token:
        raise ValueError("Debes definir ACCESS_TOKEN")

    headers = {
        "Authorization": f"Bearer {access_token}"
    }

    try:
        response = requests.get(api_url, headers=headers, timeout=30)
        response.raise_for_status()

        org = response.json()
        print("Organizacion obtenida:")
        print(f"Nombre: {org['name']}")
        print(f"RFC: {org['rfc']}")
        print(f"Régimen: {org['taxRegime']}")
        print(f"Activo: {'Sí' if org['isActive'] else 'No'}")

        return org

    except requests.exceptions.RequestException as e:
        print(f"Error al obtener organizacion: {e}")
        if e.response:
            print(f"Detalle: {e.response.text}")
        raise

if __name__ == "__main__":
    obtener_organizacion('550e8400-e29b-41d4-a716-446655440000')

Dependencias

pip install requests

PHP (Guzzle)

<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;

function obtenerOrganizacion(string $organizationId)
{
    $apiUrl = "https://sandbox.lummy.io/organizations/{$organizationId}";
    $accessToken = getenv('ACCESS_TOKEN');

    if (!$accessToken) {
        throw new Exception('Debes definir ACCESS_TOKEN');
    }

    $client = new Client(['timeout' => 30]);

    try {
        $response = $client->get($apiUrl, [
            'headers' => [
                'Authorization' => 'Bearer ' . $accessToken
            ]
        ]);

        $org = json_decode($response->getBody(), true);
        echo "Organizacion obtenida:\n";
        echo "Nombre: {$org['name']}\n";
        echo "RFC: {$org['rfc']}\n";
        echo "Régimen: {$org['taxRegime']}\n";
        echo "Activo: " . ($org['isActive'] ? 'Sí' : 'No') . "\n";

        return $org;

    } catch (RequestException $e) {
        echo "Error al obtener organizacion: " . $e->getMessage() . "\n";
        if ($e->getResponse()) {
            echo "Detalle: " . $e->getResponse()->getBody() . "\n";
        }
        throw $e;
    }
}

try {
    obtenerOrganizacion('550e8400-e29b-41d4-a716-446655440000');
} catch (Exception $e) {
    echo "Error: " . $e->getMessage() . "\n";
    exit(1);
}

Dependencias

composer require guzzlehttp/guzzle

Respuestas

Todas las respuestas siguen el formato estándar StandardResponse.

200 OK

Organización obtenida exitosamente.

{
  "requestId": "abc123-def456",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Mi Empresa S.A. de C.V.",
    "legalName": "Mi Empresa Sociedad Anónima de Capital Variable",
    "rfc": "XAXX010101000",
    "taxRegime": "601",
    "zipCode": "64000",
    "isActive": true,
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-01-15T10:30:00.000Z"
  },
  "timestamp": "2025-01-15T10:30:00.000Z",
  "path": "/organizations/550e8400-e29b-41d4-a716-446655440000",
  "method": "GET"
}

404 Not Found

La organización con el ID especificado no existe o no tienes acceso a ella.

{
  "requestId": "abc123-def456",
  "error": {
    "message": "Organization not found",
    "code": "NotFoundException",
    "status": 404
  },
  "timestamp": "2025-01-15T10:30:00.000Z",
  "path": "/organizations/550e8400-e29b-41d4-a716-446655440000",
  "method": "GET"
}

401 Unauthorized

Token inválido o expirado.

{
  "requestId": "abc123-def456",
  "error": {
    "message": "Unauthorized",
    "code": "UnauthorizedException",
    "status": 401
  },
  "timestamp": "2025-01-15T10:30:00.000Z",
  "path": "/organizations/550e8400-e29b-41d4-a716-446655440000",
  "method": "GET"
}

Próximos Pasos

• Listar Sucursales
• Crear Factura