The Idea Object

This is an object of the Ideation Room. Some properties are read-only, and others can be managed using the Management API.

Properties

• id number

  Numeric ID of the Idea

• name string

  Name of the Idea

• description string

  A description of your Idea

• content object

  The content of your Idea

• created_at string

  Creation date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

• updated_at string

  Latest update date (Format: yyyy-MM-dd'T'HH:mm:ssZ)

• deleted_at string

  Deleted date (Format: YYYY-mm-dd HH:MM)

• status string

  Status of approval

• story_ids number[]

  List of story IDs

• is_private boolean

  Defines the public or private status of the idea

• bookmarks object

  Bookmark URLs and their names with _uid

  Show child properties

  • _uid string

    UUID of the bookmark.

  • link string

    URL of the bookmark.

  • label string

    Display name of the bookmark.

• internal_tags_list object[]

  List of objects containing the details of tags used for the component

  Show child properties

  • id number

    Id of the tag

  • name string

    Name of the tag

• internal_tag_ids string[]

  List of ids of the tags assigned to the component

• author object

  The author object inside an Idea

  Show child properties

  • id number

    The numeric ID

  • avatar string

    Avatar of collaborator usually an image

  • userid string

    User ID of collaborator

  • friendly_name string

    Friendly name of collaborator

• assignee object

  The assignee object inside an Idea

  Show child properties

  • id number

    The numeric ID

  • avatar string

    Avatar of collaborator usually an image

  • userid string

    User ID of collaborator

  • friendly_name string

    Friendly name of collaborator

• stories Idea's Stories Object

  An array of the idea’s stories object

  Show child properties

  • name string

    The complete name provided for the story

  • id number

    The numeric ID

  • full_slug string

    The full slug of the story, combining the parent folder(s) and the designated story slug

Example Object

{
 "id": "11a23bbc-456d-789e-f10g-1112hi13141j",
 "name": "Lorem ipsum dolor sit amet",
 "description": null,
 "content": {},
 "created_at": "2024-12-22T13:01:21.475Z",
 "updated_at": "2024-12-22T13:01:21.475Z",
 "deleted_at": null,
 "assignee": null,
 "status": "draft",
 "author": {
   "id": 84991,
   "userid": "test@email.com",
   "friendly_name": "John doe",
   "avatar": null
 },
 "stories": [],
 "story_ids": [],
 "internal_tags_list": [],
 "internal_tag_ids": []
}