Project

Type: object

AttributeTypeDescription
idstringThe unique id of the project
namestringThe name of the project
descriptionstring (Optional)The description of the project
platformstring ("web", "ios", "android" or "macos")The target platform of the project
thumbnailstring (Optional)URL of the project's thumbnail image
statusProject Status-
organizationOrganization Summary (Optional)-
rem_preferencesrem Preferences (Optional)-
workflow_statusWorkflow Status (Optional)-
scene_urlstring (Optional)URL of the project's scene (public projects only)
createdintegerThe unix timestamp when the project was created
updatedinteger (Optional)The unix timestamp when the project was updated
number_of_membersintegerThe number of members of the project
number_of_screensintegerThe number of screens in the project
number_of_componentsintegerThe number of components exported to the project
number_of_text_stylesintegerThe number of text styles added to the project
number_of_colorsintegerThe number of colors added to the project
number_of_spacing_tokensintegerThe number of spacing tokens added to the project
linked_styleguideObject Reference (Optional)Reference the styleguide which the project is linked to

Example

{
  "id": "5db81e73e1e36ee19f138c1a",
  "name": "HAL 9000",
  "description": "UI designs for the onboard computer on the spaceship Discovery 1",
  "platform": "web",
  "thumbnail": "http://placekitten.com/200/300",
  "status": "active",
  "scene_url": "https://scene.zeplin.io/project/5db81e73e1e36ee19f138c1a",
  "created": 1517184000,
  "updated": 1572347818,
  "number_of_members": 47,
  "number_of_screens": 112,
  "number_of_components": 46,
  "number_of_text_styles": 28,
  "number_of_colors": 17,
  "linked_styleguide": {
    "id": "5db81e6e6a4462065f04d932"
  }
}
{
  "id": "5db81e73e1e36ee19f138c1a",
  "name": "HAL 9000",
  "description": "UI designs for the onboard computer on the spaceship 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"
  },
  "workflow_status": {
    "id": "5dbad85a76ea51c1f35b6f69",
    "name": "Done",
    "color": {
      "name": "yellow",
      "r": 254,
      "g": 207,
      "b": 51,
      "a": 1
    }
  },
  "number_of_members": 47,
  "number_of_screens": 112,
  "number_of_components": 46,
  "number_of_text_styles": 28,
  "number_of_colors": 17,
  "number_of_spacing_tokens": 63,
  "linked_styleguide": {
    "id": "5db81e6e6a4462065f04d932"
  }
}