--- title: "Obtener organización" description: "Devuelve la configuración pública, preparación fiscal, estado de certificados, ajustes del portal, automatización y política de acceso de caja de la organización activa." language: es-MX canonical_url: "https://exac.mx/docs/api/workspace/organization/get-organization" md_url: "https://exac.mx/docs/api/workspace/organization/get-organization.md" --- # Obtener organización Devuelve la configuración pública, preparación fiscal, estado de certificados, ajustes del portal, automatización y política de acceso de caja de la organización activa. ## Solicitud `GET /v1/organization` - **Autorización:** Permiso requerido: `org:read`. - **Entornos:** Producción y prueba - **Idempotencia:** No requerida ## Contrato canónico para máquinas Este fragmento se genera desde la operación canónica y los contratos Zod que utiliza la ruta. ```json { "method": "GET", "path": "/v1/organization", "operation": { "operationId": "getOrganization", "tags": [ "Organization" ], "summary": "Obtener organización", "description": "Devuelve la configuración pública, preparación fiscal, estado de certificados, ajustes del portal, automatización y política de acceso de caja de la organización activa.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Operación completada.", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "name": { "type": "string" }, "timeZone": { "type": "string" }, "branding": { "type": "object", "properties": { "color": { "type": "string" }, "logoUrl": { "type": "string" }, "pdfOptions": { "type": "object", "properties": { "codes": { "type": "boolean" }, "productKey": { "type": "boolean" }, "roundUnitPrice": { "type": "boolean" }, "taxBreakdown": { "type": "boolean" }, "iepsBreakdown": { "type": "boolean" }, "renderCartaPorte": { "type": "boolean" } }, "required": [ "codes", "productKey", "roundUnitPrice", "taxBreakdown", "iepsBreakdown", "renderCartaPorte" ], "additionalProperties": false } }, "additionalProperties": false }, "readiness": { "type": "object", "properties": { "production": { "type": "boolean" }, "csd": { "type": "boolean" }, "fiel": { "type": "boolean" } }, "required": [ "production", "csd", "fiel" ], "additionalProperties": false }, "certificates": { "type": "object", "properties": { "csd": { "type": "object", "properties": { "configured": { "type": "boolean" }, "expiresAt": { "type": "string" }, "serialNumber": { "type": "string" } }, "required": [ "configured" ], "additionalProperties": false }, "fiel": { "type": "object", "properties": { "configured": { "type": "boolean" }, "expiresAt": { "type": "string" } }, "required": [ "configured" ], "additionalProperties": false } }, "required": [ "csd", "fiel" ], "additionalProperties": false }, "portal": { "type": "object", "properties": { "slug": { "type": "string" }, "enabled": { "type": "boolean" }, "welcomeText": { "type": "string" }, "supportEmail": { "type": "string" }, "allowedCfdiUses": { "type": "array", "items": { "type": "string" } }, "receiptExpirationDays": { "type": "number" }, "receiptStartingFolio": { "type": "number" }, "receiptNextFolio": { "type": "number" }, "receiptLocationScopedFolios": { "type": "boolean" }, "receiptPrintWidth": { "type": "string" }, "receiptLocationRequired": { "type": "boolean" }, "receiptShowQrCode": { "type": "boolean" }, "inventoryBlockOnNegativeStock": { "type": "boolean" } }, "required": [ "enabled", "receiptLocationScopedFolios", "receiptLocationRequired", "receiptShowQrCode", "inventoryBlockOnNegativeStock" ], "additionalProperties": false }, "automation": { "type": "object", "properties": { "cfdiSyncEnabled": { "type": "boolean" }, "declarationSyncEnabled": { "type": "boolean" } }, "required": [ "cfdiSyncEnabled", "declarationSyncEnabled" ], "additionalProperties": false }, "cashierAccess": { "type": "object", "properties": { "pricingDisplay": { "type": "string", "enum": [ "show", "hide" ] }, "canCancelReceipts": { "type": "boolean" } }, "required": [ "pricingDisplay", "canCancelReceipts" ], "additionalProperties": false }, "fiscal": { "type": "object", "properties": { "legalName": { "type": "string" }, "rfc": { "type": "string" }, "taxSystem": { "type": "string" }, "rfcPersonType": { "type": "string" }, "usesBorderRegionStimulus": { "type": "boolean" }, "website": { "type": "string" }, "phone": { "type": "string" }, "address": { "type": "object", "properties": { "street": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "exterior": { "type": "string" }, "interior": { "type": "string" }, "neighborhood": { "type": "string" }, "municipality": { "type": "string" }, "postalCode": { "type": "string" } }, "required": [ "postalCode" ], "additionalProperties": false } }, "additionalProperties": false }, "globalInvoice": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "periodicity": { "type": "string" }, "eligibilityStartAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, "lastRunAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" } }, "required": [ "enabled" ], "additionalProperties": false } }, "required": [ "name", "timeZone", "branding", "readiness", "certificates", "portal", "automation", "fiscal", "globalInvoice" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false }, "example": { "data": { "name": "Ejemplo SA de CV", "timeZone": "America/Mexico_City", "branding": {}, "readiness": { "production": false, "csd": false, "fiel": false }, "certificates": { "csd": { "configured": false }, "fiel": { "configured": false } }, "portal": { "enabled": false, "receiptLocationScopedFolios": true, "receiptLocationRequired": false, "receiptShowQrCode": true, "inventoryBlockOnNegativeStock": false }, "automation": { "cfdiSyncEnabled": false, "declarationSyncEnabled": false }, "fiscal": {}, "globalInvoice": { "enabled": false } } } } } }, "400": { "description": "Solicitud inválida.\n\n`validation_error`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Credencial inválida o ausente.\n\n`unauthenticated`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" }, "WWW-Authenticate": { "$ref": "#/components/headers/WWWAuthenticate" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "La credencial no incluye el permiso `org:read`.\n\n`forbidden`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" }, "WWW-Authenticate": { "$ref": "#/components/headers/WWWAuthenticate" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Recurso no encontrado.\n\n`not_found`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "405": { "description": "Método no permitido.\n\n`method_not_allowed`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" }, "Allow": { "$ref": "#/components/headers/Allow" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Demasiadas solicitudes.\n\n`rate_limited`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "Error interno del servidor.\n\n`internal`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Servicio temporalmente no disponible.\n\n`provider_unavailable`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" }, "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "x-exac-environments": [ "production", "sandbox" ] }, "components": { "schemas": { "ApiError": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/ProgrammaticError" } }, "required": [ "error" ], "additionalProperties": false }, "ProgrammaticError": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "validation_error", "unauthenticated", "forbidden", "not_found", "method_not_allowed", "conflict", "idempotency_conflict", "operation_in_progress", "recovery_required", "rate_limited", "provider_unavailable", "internal" ], "description": "Acción recomendada por código:\n\n- `validation_error` — Corrige cada elemento de details.issues usando su path y código estable.\n- `unauthenticated` — Proporciona una API key o un token de acceso OAuth válido.\n- `forbidden` — Usa una credencial con el permiso requerido.\n- `not_found` — Verifica el identificador del recurso dentro de la organización.\n- `method_not_allowed` — Usa el método HTTP documentado.\n- `conflict` — Actualiza el recurso y resuelve su estado actual.\n- `idempotency_conflict` — Usa otra clave de idempotencia para una solicitud modificada.\n- `operation_in_progress` — Espera el tiempo de Retry-After y repite la misma solicitud.\n- `recovery_required` — No reintentes automáticamente; reconcilia el resultado del proveedor.\n- `rate_limited` — Espera el tiempo de Retry-After antes de reintentar.\n- `provider_unavailable` — Reintenta solo cuando la respuesta marque la falla como reintentable.\n- `internal` — Reintenta después y contacta a soporte si el error persiste." }, "message": { "type": "string" }, "details": { "type": "object", "properties": { "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } }, "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": false } }, "retryable": { "type": "boolean" }, "retryAfterSeconds": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "status": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "code", "message", "status" ], "additionalProperties": false } } } } ``` [OpenAPI 3.1](/openapi.json) ## Herramientas MCP equivalentes - [`get_organization`](/docs/mcp/tools/get_organization.md) Documentación completa: https://exac.mx/docs.md Índice para agentes: https://exac.mx/docs/llms.txt