Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Organizations

List my organizations
organizations.list() -> OrganizationListResponse { organizations, total }
GET/v1/organizations
Create organization
organizations.create(**kwargs) -> OrganizationCreateResponse { id, idp_org_id, idp_provider, 3 more }
POST/v1/organizations
ModelsExpand Collapse
class OrganizationListResponse { organizations, total }

Envelope for the caller’s organization memberships (paginated).

organizations: Array[{ id, idp_org_id, idp_provider, 3 more}]
id: String

Prefixed organization identifier (org_<base64-encoded-uuid>).

idp_org_id: String

IdP-issued tenant id (WorkOS org id).

idp_provider: :workos | :vitable
  • workos - WorkOS
  • vitable - Vitable
One of the following:
:workos
:vitable
name: String

Human-readable organization name.

super_in: bool

Whether this organization reads across every organization.

type: :BROKERAGE | :TPA | :GENERAL_AGENT | 3 more
  • BROKERAGE - Brokerage
  • TPA - TPA
  • GENERAL_AGENT - General Agent
  • CHANNEL_PARTNER - Channel Partner
  • CONSULTING_FIRM - Consulting Firm
  • API_PLATFORM - API Platform
One of the following:
:BROKERAGE
:TPA
:GENERAL_AGENT
:CHANNEL_PARTNER
:CONSULTING_FIRM
:API_PLATFORM
total: Integer

Total number of organizations the caller belongs to.

class OrganizationCreateResponse { id, idp_org_id, idp_provider, 3 more }
id: String

Prefixed organization identifier (org_<base64-encoded-uuid>).

idp_org_id: String

IdP-issued tenant id (WorkOS org id).

idp_provider: :workos | :vitable
  • workos - WorkOS
  • vitable - Vitable
One of the following:
:workos
:vitable
name: String

Human-readable organization name.

super_in: bool

Whether this organization reads across every organization.

type: :BROKERAGE | :TPA | :GENERAL_AGENT | 3 more
  • BROKERAGE - Brokerage
  • TPA - TPA
  • GENERAL_AGENT - General Agent
  • CHANNEL_PARTNER - Channel Partner
  • CONSULTING_FIRM - Consulting Firm
  • API_PLATFORM - API Platform
One of the following:
:BROKERAGE
:TPA
:GENERAL_AGENT
:CHANNEL_PARTNER
:CONSULTING_FIRM
:API_PLATFORM