Bootstrap

object

companyrequired: object
company.idrequired: Id
Opaque record id.
company.namerequired: string
company.slugrequired: string
company.typerequired: CompanyType
company.statusrequired: CompanyStatus
company.timezonerequired: string
IANA time zone, e.g. Asia/Kolkata.
company.localerequired: string
company.currencyrequired: string
company.brand_colorrequired: string or null
company.logo_urlrequired: string or null
company.financial_year_startrequired: integer
pipelinesrequired: array of Pipeline
Ordered; statuses and sub-statuses ordered within.
lead_sourcesrequired: array of LeadSource
custom_fieldsrequired: array of CustomFieldDefinition
Active definitions visible to the caller’s role.
settingsrequired: map of any
Client-relevant company settings (calls.*, visits.*, messaging.quiet_hours …).
planrequired: object or null
plan.coderequired: string
plan.namerequired: string
subscriptionrequired: object or null
subscription.statusrequired: SubscriptionStatus
subscription.trial_ends_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
subscription.current_period_endrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
featuresrequired: Features
Plan features after per-tenant overrides.
limitsrequired: map of number or null
Numeric plan limits after overrides; null = unlimited.
flagsrequired: map of boolean
Feature flags as they apply to this workspace (rollouts evaluated on the server).

Example

{
  "company": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string",
    "slug": "string",
    "type": "broker",
    "status": "trial",
    "timezone": "Asia/Kolkata",
    "locale": "string",
    "currency": "string",
    "brand_color": "string",
    "logo_url": "string",
    "financial_year_start": 1
  },
  "pipelines": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "lead_types": [
        "buy"
      ],
      "is_default": true,
      "sort_order": 0,
      "statuses": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "key": "string",
          "name": "string",
          "category": "open",
          "color": "string",
          "sort_order": 0,
          "is_default": true,
          "is_active": true,
          "sla_minutes": 0,
          "requirements": {},
          "sub_statuses": [
            {
              "id": null,
              "key": null,
              "name": null,
              "sort_order": null,
              "is_active": null,
              "requirements": null,
              "auto_follow_up_minutes": null,
              "counts_as_contact": null
            }
          ]
        }
      ]
    }
  ],
  "lead_sources": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "type": "string",
      "provider": "string",
      "color": "string",
      "is_active": true,
      "default_pipeline_id": "cmusrceel0000q7kaafxqi1om"
    }
  ],
  "custom_fields": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "entity": "string",
      "key": "string",
      "label": "string",
      "type": "string",
      "options": null,
      "is_required": true,
      "section": "string",
      "sort_order": 0
    }
  ],
  "settings": {},
  "plan": {
    "code": "string",
    "name": "string"
  },
  "subscription": {
    "status": "trialing",
    "trial_ends_at": "2026-10-06T05:30:00.000Z",
    "current_period_end": "2026-10-06T05:30:00.000Z"
  },
  "features": {},
  "limits": {},
  "flags": {}
}

{ "company": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "slug": "string", "type": "broker", "status": "trial", "timezone": "Asia/Kolkata", "locale": "string", "currency": "string", "brand_color": "string", "logo_url": "string", "financial_year_start": 1 }, "pipelines": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "lead_types": [ "buy" ], "is_default": true, "sort_order": 0, "statuses": [ { "id": "cmusrceel0000q7kaafxqi1om", "key": "string", "name": "string", "category": "open", "color": "string", "sort_order": 0, "is_default": true, "is_active": true, "sla_minutes": 0, "requirements": {}, "sub_statuses": [ { "id": null, "key": null, "name": null, "sort_order": null, "is_active": null, "requirements": null, "auto_follow_up_minutes": null, "counts_as_contact": null } ] } ] } ], "lead_sources": [ { "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "type": "string", "provider": "string", "color": "string", "is_active": true, "default_pipeline_id": "cmusrceel0000q7kaafxqi1om" } ], "custom_fields": [ { "id": "cmusrceel0000q7kaafxqi1om", "entity": "string", "key": "string", "label": "string", "type": "string", "options": null, "is_required": true, "section": "string", "sort_order": 0 } ], "settings": {}, "plan": { "code": "string", "name": "string" }, "subscription": { "status": "trialing", "trial_ends_at": "2026-10-06T05:30:00.000Z", "current_period_end": "2026-10-06T05:30:00.000Z" }, "features": {}, "limits": {}, "flags": {} }