Interface OrganizationInterface

Organization entity interface

Mirrors macs-node-sdk/lib/orgs/models/organization.js. Organizations are tenants that own users, agents, apps, tools, and other resources.

Example

const org: OrganizationInterface = {
  id: 'org-123',
  name: 'Acme Corp',
  description: 'Leading technology company specializing in AI solutions.',
  image: 'https://cdn.acme.example.com/logo.png',
  type: 'CLIENT',
  url: 'https://acme.example.com',
  size: '201-500',
  location: 'San Francisco, CA',
  active: true
};
interface OrganizationInterface {
    active?: boolean;
    external_id?: string;
    extensors?: { [key: string]: string };
    record_history?: RecordHistory;
    id?: string;
    name: string;
    image?: string;
    description?: string;
    type?: OrganizationType;
    url?: string;
    size?: string;
    location?: string;
    mosaia_recommendation?: string;
    agents?: any;
    apps?: any;
    clients?: any;
    models?: any;
    orgs?: any;
}

Hierarchy (View Summary)

Properties

active? external_id? extensors? record_history? id? name image? description? type? url? size? location? mosaia_recommendation? agents? apps? clients? models? orgs?

Properties

Optionalactive

active?: boolean

Whether the entity is active

Optionalexternal_id

external_id?: string

External system identifier for integration with third-party systems

Optionalextensors

extensors?: { [key: string]: string }

Extended properties for custom integrations

Optionalrecord_history

record_history?: RecordHistory

Record history tracking information

Optionalid

id?: string

Unique identifier for the organization

name

name: string

Organization name (required, unique)

Optionalimage

image?: string

URL to organization's logo/image

Optionaldescription

description?: string

Organization description

Optionaltype

type?: OrganizationType

Tenant type. SUPERORG is the control plane; CLIENT is every other tenant.

Optionalurl

url?: string

Website URL

Optionalsize

size?: string

Company size bucket (e.g. '51-200'). Free-form string on the server.

Optionallocation

location?: string

Headquarters / location string

Optionalmosaia_recommendation

mosaia_recommendation?: string

Human-readable recommendation shown on the org profile

Optional Readonlyagents

agents?: any

Optional Readonlyapps

apps?: any

Optional Readonlyclients

clients?: any

Optional Readonlymodels

models?: any

Optional Readonlyorgs

orgs?: any

Settings

Member Visibility

On This Page

Properties