List Organizations
Lists Organizations that the authenticated user has access to. Results can be filtered by display name or partner, and optionally include counts of users, teams, and brands within each organization.
Request
- Base URL: https://api.thirdfort.dev/client/api
- URL: https://api.thirdfort.dev/client/api/v1alpha2/organizations
- Auth: HTTP bearer
Query parameters
Optional limit on the number of Organizations to be returned. If not specified, the default is 25.
Optional pagination token, returned earlier via ListOrganizationsResponse.next_page_token.
Only include resources that match this filter in the response. Filtering by the following fields is supported:
- display_name
- partner_name
- state
Maximum length 2000 bytes (the limit is measured in UTF-8 bytes, not characters).
For more information, see FilterSyntax
Optional. Specifies which view of the Organization resources 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 count queries
- SUMMARY: Moderate performance impact due to user/team/brand count queries
- FULL: Slowest response due to counts plus role binding queries
Recommended usage:
-
BASIC: Organization selection dropdowns, simple lists
-
SUMMARY: Organization dashboards showing counts
-
FULL: Detailed organization management pages
-
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.
Changes
No recorded changes to this operation across all 1 revision of this API.