--- title: "Get Organization" method: GET path: "/v1alpha2/organizations/{organization}" tags: ["ClientService"] --- # Get Organization `GET /v1alpha2/organizations/{organization}` ## Request - Base URL: `https://api.thirdfort.dev/client/api` - URL: `https://api.thirdfort.dev/client/api/v1alpha2/organizations/{organization}` - Auth: HTTP bearer Returns the requested Organization by its resource name. Optionally includes counts of users, teams, brands, and role bindings associated with the organization. ## Path parameters - `organization` string, required ## Query parameters - `view` 'ORGANIZATION_VIEW_UNSPECIFIED' | 'ORGANIZATION_VIEW_BASIC' | 'ORGANIZATION_VIEW_SUMMARY' | 'ORGANIZATION_VIEW_FULL' | 'ORGANIZATION_VIEW_NAME_ONLY' ## Response `200` A successful response. - Organization: An [Organization](#/schemas/Organization) is the top-level entity in the system and represents a company or other organizational entity that uses Thirdfort's compliance services. Organizations contain teams, users, and brands, and serve as the primary boundary for access control and billing. - `name` string: The unique resource name of the organization. Format: `organizations/{organization}`. This field is system-generated and immutable. - `displayName` string, required: Human-readable organization name displayed in user interfaces. This is typically the company or entity name. - `partner` string: The Partner managing this organization, derived from the managing-partner grant — the role binding whose principal is the partner (CDD-7556). Unset when no partner manages the organization; at most one partner can (CDD-7557). - `package` 'PACKAGE_UNSPECIFIED' | 'PROPERTY_ESSENTIALS' | 'PROPERTY_FLOW' | 'PROPERTY_ENTERPRISE' | 'LEGAL_ESSENTIALS' | 'LEGAL_COMPLIANCE' | 'LEGAL_ENTERPRISE' | 'ACCOUNTING_ESSENTIALS' | 'ACCOUNTING_RISK' | 'ACCOUNTING_ENTERPRISE': Available package types. - `notes` string: Administrative notes about the organization. This field is only populated when using SUMMARY or FULL view in API calls. - `zendeskUrl` string: The Zendesk URL for the organization. - `salesforceUrl` string: The Salesforce URL for the organization. - `featureSettings` Feature[]: The list of [Feature](#/schemas/Feature) for this [Organization](#/schemas/Organization). - `type` 'FEATURE_UNSPECIFIED' | 'KYC_IDV_ENHANCED' | 'KYC_IDV_ORIGINAL' | 'KYC_DOCUMENT_VERIFICATION' | 'KYC_PROOF_OF_ADDRESS' | 'KYC_PROOF_OF_OWNERSHIP' | 'AML_LITE_SCREENING' | 'AML_STANDALONE_SCREENING' | 'AML_ONGOING_MONITORING' | 'SOF_QUESTIONNAIRE' | 'SOF_GIFTOR_QUESTIONNAIRE' | 'SECURE_SHARE' | 'TITLE_DOCS_LEASEHOLD' | 'TITLE_DOCS_PLAN_FREEHOLD' | 'TITLE_DOCS_PLAN_LEASEHOLD' | 'TITLE_DOCS_REGISTER_FREEHOLD' | 'KYB_ANNUAL_ACCOUNTS' | 'KYB_ANNUAL_RETURN' | 'KYB_ARTICLES_ASSOCIATION' | 'KYB_BENEFICIAL_CHECK' | 'KYB_CREDIT_CHECK' | 'KYB_CREDIT_REPORT' | 'KYB_FILED_CHANGES' | 'KYB_FILED_DOCUMENTS' | 'KYB_REGISTER_CHECK' | 'KYB_REGISTER_EXTRACT' | 'KYB_REGISTER_REPORT' | 'KYB_SANCTIONS' | 'KYB_SANCTIONS_MONITORING' | 'KYB_SHAREHOLDERS' | 'KYB_SUMMARY_REPORT' | 'KYB_TRADE_REGISTER' | 'KYB_UBO_REPORT' | 'INTERNATIONAL_ADDRESS_VERIFICATION' | 'KYC_CCJ_INSOLVENCY' | 'BANKING_DATA' | 'REVIEW_TASKS' | 'TASK_MANAGER' | 'FIRM_WIDE_INSIGHTS' | 'RIGHT_TO_RENT': The type of feature representing specific compliance capabilities. - `state` 'STATE_UNSPECIFIED' | 'ENABLED' | 'DISABLED', required: The operational state of the feature. - STATE_UNSPECIFIED: Default value. This value is unused. - ENABLED: The feature is enabled and available for use. - DISABLED: The feature is disabled and not available for use. - `scope` 'SCOPE_UNSPECIFIED' | 'INTERNAL' | 'CLIENT': Feature visibility scope. - INTERNAL: Only visible to admin users. - CLIENT: Visible to external clients. - `featureSetSettings` FeatureSet[]: The list of [FeatureSet](#/schemas/FeatureSet) for this [Organization](#/schemas/Organization). - `type` 'FEATURESET_UNSPECIFIED' | 'KYC' | 'KYB' | 'AML_SCREENING' | 'SOF' | 'TITLE_DOCS' | 'SECURE_SHARE' | 'BILLING_USAGE_RISK_REPORTING' | 'CLIENT_BULK_UPLOAD' | 'TF_API' | 'CUSTOM_SCREENING' | 'SSO' | 'BESPOKE_REPORTING' | 'INTERNATIONAL_ADDRESS_VERIFICATION' | 'MONITORING_ANALYTICS' | 'TASK_MANAGEMENT' | 'FIRM_WIDE_INSIGHTS' | 'RIGHT_TO_RENT': Feature set type. - MONITORING_ANALYTICS: Monitoring analytics dashboard — view org-level monitoring graphs. - TASK_MANAGEMENT: Task Manager dashboard and Review Tasks workflow. - FIRM_WIDE_INSIGHTS: Firm-Wide Insights dashboard: firm-level compliance analytics and reporting. - RIGHT_TO_RENT: Right to Rent: the certified digital route for establishing a tenant's right to rent residential property in England. - `kind` 'KIND_UNSPECIFIED' | 'PRODUCT' | 'SERVICE': Feature set kind. - PRODUCT: Core compliance product. - SERVICE: Additional platform service. - `features` Feature[]: The features included in this set. - `type` 'FEATURE_UNSPECIFIED' | 'KYC_IDV_ENHANCED' | 'KYC_IDV_ORIGINAL' | 'KYC_DOCUMENT_VERIFICATION' | 'KYC_PROOF_OF_ADDRESS' | 'KYC_PROOF_OF_OWNERSHIP' | 'AML_LITE_SCREENING' | 'AML_STANDALONE_SCREENING' | 'AML_ONGOING_MONITORING' | 'SOF_QUESTIONNAIRE' | 'SOF_GIFTOR_QUESTIONNAIRE' | 'SECURE_SHARE' | 'TITLE_DOCS_LEASEHOLD' | 'TITLE_DOCS_PLAN_FREEHOLD' | 'TITLE_DOCS_PLAN_LEASEHOLD' | 'TITLE_DOCS_REGISTER_FREEHOLD' | 'KYB_ANNUAL_ACCOUNTS' | 'KYB_ANNUAL_RETURN' | 'KYB_ARTICLES_ASSOCIATION' | 'KYB_BENEFICIAL_CHECK' | 'KYB_CREDIT_CHECK' | 'KYB_CREDIT_REPORT' | 'KYB_FILED_CHANGES' | 'KYB_FILED_DOCUMENTS' | 'KYB_REGISTER_CHECK' | 'KYB_REGISTER_EXTRACT' | 'KYB_REGISTER_REPORT' | 'KYB_SANCTIONS' | 'KYB_SANCTIONS_MONITORING' | 'KYB_SHAREHOLDERS' | 'KYB_SUMMARY_REPORT' | 'KYB_TRADE_REGISTER' | 'KYB_UBO_REPORT' | 'INTERNATIONAL_ADDRESS_VERIFICATION' | 'KYC_CCJ_INSOLVENCY' | 'BANKING_DATA' | 'REVIEW_TASKS' | 'TASK_MANAGER' | 'FIRM_WIDE_INSIGHTS' | 'RIGHT_TO_RENT': The type of feature representing specific compliance capabilities. - `state` 'STATE_UNSPECIFIED' | 'ENABLED' | 'DISABLED', required: The operational state of the feature. - STATE_UNSPECIFIED: Default value. This value is unused. - ENABLED: The feature is enabled and available for use. - DISABLED: The feature is disabled and not available for use. - `scope` 'SCOPE_UNSPECIFIED' | 'INTERNAL' | 'CLIENT': Feature visibility scope. - INTERNAL: Only visible to admin users. - CLIENT: Visible to external clients. - `state` 'STATE_UNSPECIFIED' | 'ENABLED' | 'DISABLED', required: The operational state of the feature set. - STATE_UNSPECIFIED: Default value. This value is unused. - ENABLED: The feature set is enabled and available for use. - DISABLED: The feature set is disabled and not available for use. - `type` 'TYPE_UNSPECIFIED' | 'DIRECT' | 'INTEGRATION' | 'PLATFORM_PARTNER' | 'RESELLER': The type of the organization represents the way they consume Thirdfort services. - DIRECT: This type of organization has a direct commercial relationship with Thirdfort and uses Thirdfort products directly via the portal. - INTEGRATION: This type of organization has a direct commercial relationship with Thirdfort and uses Thirdfort products via an API integration with their own system. - PLATFORM_PARTNER: This type of organization has a direct commercial relationship with Thirdfort, but uses Thirdfort products via a platform partner. - RESELLER: This type of organization has a commercial relationship with a reseller who manages support and billing. - `state` 'STATE_UNSPECIFIED' | 'ACTIVE' | 'INACTIVE': The operational state of the organization. - STATE_UNSPECIFIED: Default value. This value is unused. - ACTIVE: The organization is active and can perform all operations. Users can create checks, access resources, and perform all normal functions. - INACTIVE: The organization has been deactivated it and its users have no access. - `userCount` integer: Count of [Users](#/schemas/User) within this organization. This field is only populated when using SUMMARY or FULL view in API calls. See OrganizationView enum for details on view-based field inclusion. - `teamCount` integer: Count of [Teams](#/schemas/Team) within this organization. This field is only populated when using SUMMARY or FULL view in API calls. See OrganizationView enum for details on view-based field inclusion. - `brandCount` integer: Count of [Brands](#/schemas/Brand) within this organization. This field is only populated when using SUMMARY or FULL view in API calls. See OrganizationView enum for details on view-based field inclusion. - `roleBindings` RoleBinding[]: List of [RoleBindings](#/schemas/RoleBinding) for this [Organization](#/schemas/Organization) if requested. - `principal` string, required: The name of the principal this role binding applies to, in the canonical form for its type e.g. organizations/foo/users/bar. Valid types are: [User](#/schemas/User), [Group](#/schemas/Group) (both assignable via CreateRoleBinding), and integrations (e.g. partners/foo/integrations/1), whose bindings are managed by the system when an integration is set up. - `role` 'ROLE_UNSPECIFIED' | 'role_global_admin' | 'role_organization_admin' | 'role_team_admin' | 'role_team_creator' | 'role_team_viewer' | 'role_team_approver' | 'role_team_manual_task_analyst' | 'role_ai_chat_usage' | 'role_partner_integration' | 'role_organization_integration' | 'role_complyadvantagesetting_admin' | 'role_screening_configuration_admin' | 'role_support' | 'role_tech' | 'role_global_viewer' | 'role_global_role_admin' | 'role_global_monitoring_admin' | 'role_organization_monitoring_viewer' | 'role_team_review_admin' | 'role_team_review_initiator' | 'role_team_reviewer' | 'role_team_manual_task_admin' | 'role_organization_compliance_admin' | 'role_advanced_aml_user' | 'role_secure_share_viewer' | 'role_team_integration' | 'role_organization_creator', required: Role defines the permissions that can be assigned via a RoleBinding. - `resource` string, required - `stateReason` 'STATE_REASON_UNSPECIFIED' | 'TRIAL' | 'TRIAL_ENDED' | 'CHURNED' | 'DELINQUENT_PAYMENT': The specific reason for the current state of the organization. - STATE_REASON_UNSPECIFIED: Default value. Allowed only when State is ACTIVE - TRIAL: The organization is in a trial period. Allowed only when State is ACTIVE - TRIAL_ENDED: The organization's trial period has ended. Allowed only when State is INACTIVE - CHURNED: The organization has churned and is no longer a client. Allowed only when State is INACTIVE - DELINQUENT_PAYMENT: The organization has a delinquent payment. Allowed only when State is INACTIVE - `sectors` IndustryType[]: The sectors the organization works in. Defaults to the industry of the organization's package. Only Thirdfort can change them. Duplicates are rejected. ## Other responses - `default`: An unexpected error response. --- [API](https://skmtc.dev/thirdfort/apis/thirdfort-client-api-preview.md) - [All operations](https://skmtc.dev/thirdfort/apis/thirdfort-client-api-preview/llms.txt) - [OpenAPI document](https://skmtc.dev/thirdfort/apis/thirdfort-client-api-preview/revisions/3446b9aefa90?raw)