ClientService

Get Organization

Returns the requested Organization by its resource name. Optionally includes counts of users, teams, brands, and role bindings associated with the 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

Path parameters

organizationstring required

The organization identifier of the resource path.

Query parameters

view'ORGANIZATION_VIEW_UNSPECIFIED' | 'ORGANIZATION_VIEW_BASIC' | 'ORGANIZATION_VIEW_SUMMARY' | 'ORGANIZATION_VIEW_FULL' | 'ORGANIZATION_VIEW_NAME_ONLY'

Optional. Specifies which view of the Organization resource to return. When unspecified, defaults to BASIC view which includes core organization fields without expensive count computations or related resource queries.

Performance implications:

  • BASIC: Fast response, no additional queries
  • SUMMARY: Moderate performance impact due to user/team/brand count queries
  • FULL: Slowest response due to counts plus role binding queries

Use BASIC for navigation and simple operations, SUMMARY for dashboards, FULL for comprehensive organization management interfaces.

  • ORGANIZATION_VIEW_UNSPECIFIED: Default value. When used, defaults to BASIC view. This ensures backward compatibility for clients not specifying a view.

  • ORGANIZATION_VIEW_BASIC: Basic view includes core organization information without expensive computations. This view provides essential organization data needed for most operations while avoiding performance overhead from count calculations and related resource queries.

Includes:

  • name: The unique resource identifier

  • display_name: Human-readable organization name

  • partner: Parent partner resource (when available)

  • package: Subscription package type

  • notes: Administrative notes

  • zendesk_url: Support system URL

  • salesforce_url: CRM system URL

  • type: Organization type (DIRECT, INTEGRATION, etc.)

  • state: Current operational state (ACTIVE, INACTIVE)

  • state_reason: Specific reason for current state

  • ORGANIZATION_VIEW_SUMMARY: Summary view includes basic information plus count data. This view is optimized for organization listing interfaces where counts are needed for display but detailed related resources are not required.

Includes:

  • All BASIC fields

  • user_count: Number of users within this organization

  • team_count: Number of teams within this organization

  • brand_count: Number of brands within this organization

  • ORGANIZATION_VIEW_FULL: Full view includes all available organization information including related resources. This view should be used when complete organization context is required, such as for detailed organization management operations or comprehensive administration.

Includes:

  • All SUMMARY fields

  • role_bindings: Complete list of role assignments and permissions

  • feature_settings: Individual feature configurations

  • feature_set_settings: Feature set configurations

  • ORGANIZATION_VIEW_NAME_ONLY: Name-only view exposes just enough to identify an organization, for callers who may see which organization a resource belongs to but nothing more about it (e.g. cross-org secure-share viewers). It is a strict subset of BASIC.

Includes:

  • name: The unique resource identifier
  • display_name: Human-readable organization name

Response

A successful response.

namestring

The unique resource name of the organization. Format: organizations/{organization}. This field is system-generated and immutable.

displayNamestring required

Human-readable organization name displayed in user interfaces. This is typically the company or entity name.

partnerstring

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.

notesstring

Administrative notes about the organization. This field is only populated when using SUMMARY or FULL view in API calls.

zendeskUrlstring

The Zendesk URL for the organization.

salesforceUrlstring

The Salesforce URL for the organization.

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.

userCountinteger

Count of Users 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.

teamCountinteger

Count of Teams 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.

brandCountinteger

Count of Brands 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.

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
sectorsIndustryType[]

The sectors the organization works in. Defaults to the industry of the organization's package. Only Thirdfort can change them. Duplicates are rejected.

Changes

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