Organizations

Request organization information

get/organizations/{organizationId}

Request

  • Base URL: https://api.xfa.tech
  • URL: https://api.xfa.tech/organizations/{organizationId}
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

ID of Organization

Response

Returns the organization

organization_idstring required

ID of Organization

namestring required

Name of Organization

addressstring required

Address of Organization

zip_codestring required

Zip Code of Organization

citystring required

City of Organization

countrystring required

Country of Organization

vatstring required

VAT of Organization

tax_numberstring required

Tax Number of Organization

phone_numberstring required

Phone Number of Organization

billing_emailstring required

Billing Email of Organization

billing_namestring

Billing Name of Organization

billing_first_namestring

Billing First Name of Organization

billing_last_namestring

Billing Last Name of Organization

deletedboolean

Whether the organization is deleted

logo_urlstring

URL of the logo

notify_no_managed_devicesboolean

Notify no managed devices

notify_no_desktop_devicesboolean

Notify no desktop devices

notify_no_mobile_devicesboolean

Notify no mobile devices

notify_discovered_devicesboolean

Notify discovered devices

notify_discovered_devices_frequency_in_daysinteger

Frequency of notification for discovered devices

invite_discovered_devicesboolean

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_enabledboolean

Allow verified native app users to request self-invite when eligible

exclude_from_customer_metricsboolean

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_devicesboolean

Notify unsafe devices

notify_unsafe_devices_frequency_in_daysinteger

Frequency of notification for unsafe devices

slack_enabledboolean

Enable Slack DMs for device risk notifications

slack_notify_unsafe_devicesboolean

Send Slack DMs to users about unsafe devices

slack_notify_discovered_devicesboolean

Send Slack DMs to users about discovered devices

slack_invite_discovered_devicesboolean

Send invitation Slack DMs to users with discovered devices

manual_invite_send_slackboolean

Last-used Slack toggle state in the manual Invite users popup.

teams_notify_unsafe_devicesboolean

Send Teams DMs to users about unsafe devices

teams_notify_discovered_devicesboolean

Send Teams DMs to users about discovered devices

teams_invite_discovered_devicesboolean

Send invitation Teams DMs to users with discovered devices

manual_invite_send_teamsboolean

Last-used Microsoft Teams toggle state in the manual Invite users popup.

default_policy_idstring

Default Policy ID of Organization

use_user_agent_and_client_hintsboolean

Use user-agent and client hints from browser to complete checks

use_discovery_databoolean

Use Discovery data to complete checks

google_chrome_device_trustboolean

Google Chrome device trust

feature_flagsFeatureFlag[]

Feature flags enabled for this organization

getting_started_statestring

JSON blob owned by the dashboard's Getting Started journey; opaque to the backend.

referred_bystring

Email of the dashboard user whose referral code this organization signed up with, if any.

timestampstring date-time required

Created timestamp of the organization

Example response

{
  "feature_flags": [
    "play_protect"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.