Styleguide

Type: object

AttributeTypeDescription
idstringThe unique id of the styleguide
namestringThe name of the styleguide
descriptionstring (Optional)The description of the styleguide (It can contain markdown https://zpl.io/article/markdown-support)
platformstring ("base", "web", "ios", "android" or "macos")The target platform of the styleguide
thumbnailstring (Optional)URL of the styleguide's thumbnail image
statusStyleguide Status-
organizationOrganization Summary (Optional)-
rem_preferencesrem Preferences (Optional)-
createdintegerThe unix timestamp when the styleguide was created
updatedinteger (Optional)The unix timestamp when the styleguide was updated
number_of_membersintegerThe number of members of the styleguide
number_of_componentsintegerThe number of components exported to the styleguide
number_of_text_stylesintegerThe number of text styles added to the styleguide
number_of_colorsintegerThe number of colors added to the styleguide
number_of_spacing_tokensintegerThe number of spacing tokens added to the styleguide
parentObject Reference (Optional)Reference of the parent styleguide

Example

{
  "id": "5db981be9df2b3e1bfa19ef2",
  "name": "Discovery 1",
  "description": "Global styleguide for all projects of Discovery 1.",
  "platform": "web",
  "thumbnail": "http://placekitten.com/200/300",
  "status": "active",
  "created": 1517184000,
  "updated": 1572347818,
  "number_of_members": 13,
  "number_of_components": 241,
  "number_of_text_styles": 48,
  "number_of_colors": 37,
  "parent": {
    "id": "5db981b14ce405d079b376f0"
  }
}
{
  "id": "5db981be9df2b3e1bfa19ef2",
  "name": "Discovery 1",
  "description": "Global styleguide for all projects of Discovery 1.",
  "platform": "web",
  "thumbnail": "http://placekitten.com/200/300",
  "status": "active",
  "created": 1517184000,
  "updated": 1572347818,
  "organization": {
    "id": "5d9caaecb4a3fa9b972f86ce",
    "name": "Acme, Inc.",
    "logo": "http://placekitten.com/200/300"
  },
  "number_of_members": 13,
  "number_of_components": 241,
  "number_of_text_styles": 48,
  "number_of_colors": 37,
  "number_of_spacing_tokens": 21,
  "parent": {
    "id": "5db981b14ce405d079b376f0"
  }
}