Skip to main content

OrganisationResponsePublic

organisation object
statusstring

Possible values: [i-am-teapot, draft, active, setup, suspended, archived]

Default value: draft
ksuidstring

ID of the organisation

organisationstring

Short slug used to represent the org

namestringrequired

The name of the organisation.

Possible values: >= 2 characters

account_idstring

The Stripe account ID associated with the organisation

bannerstring

URL to the banner image for the organisation

banner_overlaystring

URL to the banner overlay image for the organisation

logostring

URL to the logo image for the organisation

theme object
css_varsstring

CSS variables for the organisation theme, used to customise SOLO templates

colour_primarystring

Primary colour for the organisation theme, used for branding and UI accents

colour_secondarystring

Secondary colour for the organisation theme, used for supporting accents

colour_backgroundstring

Background colour for the organisation theme

colour_background_altstring

Alternative background colour for the organisation theme

colour_surface_lightstring

Light surface colour for the organisation theme

colour_surface_darkstring

Dark surface colour for the organisation theme

descriptionstring
created_atstring<date-time>
updated_atstring<date-time>
versioninteger
historyobject[]
logo_secondary_urlstring

Secondary URL to the logo image for the organisation, used for dark mode or alternative themes

logo_icon_urlstring

URL to the icon version of the logo for the organisation, used in places where a smaller or simplified logo is needed

OrganisationResponsePublic
{
  "organisation": {
    "status": "draft",
    "ksuid": "string",
    "organisation": "string",
    "name": "string",
    "account_id": "string",
    "banner": "string",
    "banner_overlay": "string",
    "logo": "string",
    "theme": {
      "css_vars": "string",
      "colour_primary": "string",
      "colour_secondary": "string",
      "colour_background": "string",
      "colour_background_alt": "string",
      "colour_surface_light": "string",
      "colour_surface_dark": "string"
    },
    "description": "string",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "version": 0,
    "history": [
      {}
    ],
    "logo_secondary_url": "string",
    "logo_icon_url": "string"
  }
}