--- title: "Get organization" description: "Returns the active organization’s public configuration, fiscal readiness, certificate status, portal settings, automation, and cashier access policy." language: en canonical_url: "https://exac.mx/docs/en/api/workspace/organization/get-organization" md_url: "https://exac.mx/docs/en/api/workspace/organization/get-organization.md" --- # Get organization Returns the active organization’s public configuration, fiscal readiness, certificate status, portal settings, automation, and cashier access policy. ## Request `GET /v1/organization` - **Authorization:** Required permission: `org:read`. - **Environments:** Production and sandbox - **Idempotency:** Not required ## Canonical machine contract This fragment is generated from the canonical operation and Zod contracts used by the route. ```json { "method": "GET", "path": "/v1/organization", "operation": { "operationId": "getOrganization", "tags": [ "Organization" ], "summary": "Get organization", "description": "Returns the active organization’s public configuration, fiscal readiness, certificate status, portal settings, automation, and cashier access policy.", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Operation completed.", "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": "Invalid request.\n\n`validation_error`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "Missing or invalid credential.\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": "The credential does not include the `org:read` permission.\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": "Resource not found.\n\n`not_found`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "405": { "description": "Method not allowed.\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": "Too many requests.\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": "Internal server error.\n\n`internal`", "headers": { "Request-Id": { "$ref": "#/components/headers/RequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "503": { "description": "Service temporarily unavailable.\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": "Recommended action by code:\n\n- `validation_error` — Correct each details.issues entry using its path and stable issue code.\n- `unauthenticated` — Provide a valid API key or OAuth access token.\n- `forbidden` — Use a credential with the required permission.\n- `not_found` — Check the organization-scoped resource identifier.\n- `method_not_allowed` — Use the documented HTTP method.\n- `conflict` — Refresh the resource and resolve its current state.\n- `idempotency_conflict` — Use a new idempotency key for a changed request.\n- `operation_in_progress` — Wait for Retry-After, then repeat the exact request.\n- `recovery_required` — Do not retry automatically; reconcile the provider outcome.\n- `rate_limited` — Wait for Retry-After before retrying.\n- `provider_unavailable` — Retry only when the response marks the failure as retryable.\n- `internal` — Retry later and contact support if the error persists." }, "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) ## Equivalent MCP tools - [`get_organization`](/docs/en/mcp/tools/get_organization.md) Complete documentation: https://exac.mx/docs/en.md Agent documentation index: https://exac.mx/docs/en/llms.txt