Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference

Organizations

List my organizations
client.organizations.list(RequestOptionsoptions?): OrganizationListResponse { organizations, total }
GET/v1/organizations
Create organization
client.organizations.create(OrganizationCreateParams { name, type } body, RequestOptionsoptions?): OrganizationCreateResponse { id, idp_org_id, idp_provider, 3 more }
POST/v1/organizations
ModelsExpand Collapse
OrganizationListResponse { organizations, total }

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

organizations: Array<Organization>
id: string

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

idp_org_id: string | null

IdP-issued tenant id (WorkOS org id).

idp_provider: "workos" | "vitable" | null
  • workos - WorkOS
  • vitable - Vitable
One of the following:
"workos"
"vitable"
name: string

Human-readable organization name.

super_in: boolean

Whether this organization reads across every organization.

type: "BROKERAGE" | "TPA" | "GENERAL_AGENT" | 3 more | null
  • 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: number

Total number of organizations the caller belongs to.

OrganizationCreateResponse { id, idp_org_id, idp_provider, 3 more }
id: string

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

idp_org_id: string | null

IdP-issued tenant id (WorkOS org id).

idp_provider: "workos" | "vitable" | null
  • workos - WorkOS
  • vitable - Vitable
One of the following:
"workos"
"vitable"
name: string

Human-readable organization name.

super_in: boolean

Whether this organization reads across every organization.

type: "BROKERAGE" | "TPA" | "GENERAL_AGENT" | 3 more | null
  • 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"