--- title: "Return all organizations" method: GET path: "/organizations" tags: ["Organizations"] --- # Return all organizations `GET /organizations` ## Request - Base URL: `https://api.xfa.tech` - URL: `https://api.xfa.tech/organizations` - Auth: HTTP bearer ## Query parameters - `start` integer - `limit` integer ## Response `200` Returns all organizations - OrganizationsListResponse - `total` integer: The total number of organizations - `start` integer: The index of the first organization returned - `limit` integer: The maximum number of organizations returned - `items` OrganizationResponse[] - `awareness_schedule` AwarenessSchedule: Next nominal hourly Awareness evaluation in production (minute 30, UTC), not a guaranteed delivery time. Recipient cooldowns, scope, billing and channel availability are checked at execution. Absent outside production or when all automations are disabled. Reload to refresh expired times. Risk alerts currently require notify_unsafe_devices, including Slack/Teams. - `auto_invite` AwarenessAutomationSchedule - `next_run_at` string, date-time, required: Next scheduled Awareness evaluation, in UTC; actual delivery is conditional. - `setup_reminder` AwarenessAutomationSchedule - `next_run_at` string, date-time, required: Next scheduled Awareness evaluation, in UTC; actual delivery is conditional. - `risk_alert` AwarenessAutomationSchedule - `next_run_at` string, date-time, required: Next scheduled Awareness evaluation, in UTC; actual delivery is conditional. - `organization_id` string, required: ID of Organization - `name` string, required: Name of Organization - `address` string, required: Address of Organization - `zip_code` string, required: Zip Code of Organization - `city` string, required: City of Organization - `country` string, required: Country of Organization - `vat` string, required: VAT of Organization - `tax_number` string, required: Tax Number of Organization - `phone_number` string, required: Phone Number of Organization - `billing_email` string, required: Billing Email of Organization - `billing_name` string: Billing Name of Organization - `billing_first_name` string: Billing First Name of Organization - `billing_last_name` string: Billing Last Name of Organization - `deleted` boolean: Whether the organization is deleted - `logo_url` string: URL of the logo - `notify_no_managed_devices` boolean: Notify no managed devices - `notify_no_desktop_devices` boolean: Notify no desktop devices - `notify_no_mobile_devices` boolean: Notify no mobile devices - `notify_discovered_devices` boolean: Notify discovered devices - `notify_discovered_devices_frequency_in_days` integer: Frequency of notification for discovered devices - `invite_discovered_devices` boolean: Invite discovered devices - `default_language` '' | 'en' | 'nl' | 'fr' | 'de' | 'es': Language for end-user emails when the recipient has not picked one; a user's own choice always wins. The set mirrors the email templates shipped by xfa-notification-service. An empty string is the canonical way to clear the organization default, on both PUT and PATCH, so the whole organization can be saved in one request; xfa-organizations-service stores it as an absent attribute. - `self_invite_enabled` boolean: Allow verified native app users to request self-invite when eligible - `exclude_from_customer_metrics` boolean: Keeps this organization out of company-wide customer metrics. Set on XFA's own organizations. Only system administrators may change it; an org admin sending the stored value back is accepted. - `notify_unsafe_devices` boolean: Notify unsafe devices - `notify_unsafe_devices_frequency_in_days` integer: Frequency of notification for unsafe devices - `slack_enabled` boolean: Enable Slack DMs for device risk notifications - `slack_notify_unsafe_devices` boolean: Send Slack DMs to users about unsafe devices - `slack_notify_discovered_devices` boolean: Send Slack DMs to users about discovered devices - `slack_invite_discovered_devices` boolean: Send invitation Slack DMs to users with discovered devices - `manual_invite_send_slack` boolean: Last-used Slack toggle state in the manual Invite users popup. - `teams_notify_unsafe_devices` boolean: Send Teams DMs to users about unsafe devices - `teams_notify_discovered_devices` boolean: Send Teams DMs to users about discovered devices - `teams_invite_discovered_devices` boolean: Send invitation Teams DMs to users with discovered devices - `manual_invite_send_teams` boolean: Last-used Microsoft Teams toggle state in the manual Invite users popup. - `notify_only_groups` object[] - `name` string - `id` string - `default_policy_id` string: Default Policy ID of Organization - `use_user_agent_and_client_hints` boolean: Use user-agent and client hints from browser to complete checks - `use_discovery_data` boolean: Use Discovery data to complete checks - `google_chrome_device_trust` boolean: Google Chrome device trust - `microsoft_edge_device_trust` object - `tenant_id` string: Tenant ID for device trust - `client_id` string: Client ID for device trust - `feature_flags` FeatureFlag[]: Feature flags enabled for this organization - `getting_started_state` string: JSON blob owned by the dashboard's Getting Started journey; opaque to the backend. - `referred_by` string: Email of the dashboard user whose referral code this organization signed up with, if any. - `timestamp` string, date-time, required: Created timestamp of the organization - `active_users` ActiveUsers - `current_insight` integer: Current insight users count - `last_insight` integer: Last insight users count - `current_connect` integer: Current connect users count - `last_connect` integer: Last connect users count - `current_user_count` integer: Current total users count - `last_user_count` integer: Last total users count - `current_verifications` integer: Enforcement verifications this month: warned + blocked + secure sign-ins + snoozed - `last_verifications` integer: Enforcement verifications last month - `current_granted` integer: Sign-ins an administrator manually granted this month. Not counted as verifications. - `last_granted` integer: Sign-ins an administrator manually granted last month - `lifetime_verifications` integer: Enforcement verifications since counting started (2025-01-28; secure sign-ins only since 2026-01-26), so a floor - `year_verifications` integer: Enforcement verifications since 1 January of the current year (UTC) - `last_7_days_verifications` integer: Enforcement verifications over the 7 full days before today (UTC). Divide by 7 for the daily rate. - `invoice` Invoice - `number` string: Invoice number - `date` string, date: Invoice date - `amount` number, float: Invoice amount - `settings` Settings - `organization_id` string: ID of the organization - `insight_price` number, float: Price for insight - `connect_price` number, float: Price for connect - `free_devices` integer: Number of free devices - `trial_end_date` string, date: End date of the trial period - `per_user_price` number, float: Price per user - `blocked_access` boolean: Whether access is blocked --- [API](https://skmtc.dev/xfa/apis/xfa-api.md) · [All operations](https://skmtc.dev/xfa/apis/xfa-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xfa/apis/xfa-api/revisions/1a1be0e8972b?raw)