API - Ideas

/ideas

Get a list of Ideas

Params

program	String	optional	The program ID
userId	String	optional	A user ID
userEmail	String	optional	A user's email
status	String	optional	One of: Published, Awaiting Review, Approved, Declined, Transferred, Combined

If program is not included in the query, all ideas for the account will be returned.

The following request will retrieve all ideas in a program that are awaiting review:

Example Request:

axios.get('https://acmecorp.launchpath.io/api/v1-beta/ideas', {
  headers: {
    Authentication: `Bearer ${process.env.LAUNCHPATH_API_TOKEN}`,
    Accept: 'application/json',
  },
  params: {
    program: '632b771832d29d840043f72a',
    status: 'Awaiting Review',
  },
})

Example Response:

{
  "items": [
    {
      "_id": "58cbf654b857587a112f9240",
      "name": "IT Revolution",
      "description": "Taking information technology to the next level",
      "author": {
        "_id": "632b771832d29d840043f72a",
        "email": "david.castillo@acmecorp.biz",
        "name": "David Castillo"
      },
      "status": "Published",
      "content": {...},
      "createdAt": "2021-04-28T21:04:58.731+00:00",
      "updatedAt": "2021-04-28T21:04:58.731+00:00",
      "publishedAt": "2021-04-28T21:04:58.731+00:00",
      "submittedAt": "2021-04-28T21:04:58.731+00:00"
      // ...
    },
    {
      "_id": "590b8abc654e3610c3e4bdfc",
      "name": "AI for Infrastructure",
      "description": "Utilizing the power of AI to ensure infrastructure resilience",
      "author": {
        "_id": "5c1bd6c57bc30c64bd797d86",
        "email": "william.schmidt@acmecorp.biz",
        "name": "Bill Schmidt"
      },
      "status": "Awaiting Review",
      "content": {...},
      "createdAt": "2021-04-28T21:04:58.731+00:00",
      "updatedAt": "2021-04-28T21:04:58.731+00:00", 
      "publishedAt": "2021-04-28T21:04:58.731+00:00",
      "submittedAt": "2021-04-28T21:04:58.731+00:00"
      // ...
    }
  ]
}

Note that content is a dynamic object whose keys will vary according to your program configuration.

Post an Idea

Post Body Properties

name	String	optional	The Idea's name
description	String	optional	Idea description
userId	String	optional	A user ID
userEmail	String	optional	A user's email
content	Object	optional	Key-value pairs. Content keys will vary according to your program settings.
program	String	optional	Program ID

One of content or description is required to post an Idea.

If userId is included, the idea will be attributed to that user by ID.
If userEmail is included, the user's ID will be retrieved via their email address to attribute the idea.
If userId and userEmail are both included, userId will take precedence.
If userEmail is included, but the user does not exist, we will create a new user with that email address.
If neither userId nor userEmail are included, the idea will be attributed to the account's default user. Program admins will then need to transfer ownership of the idea to an active user.

Ideas posted through the API will be given a status of "Draft". To progress through the innovation workflow, the Idea will need to be published from within the LaunchPath system.
If program is not included with the Idea, it will be set to the account's default Program.
If AI features are enabled for your account, name will be generated automatically if not included.

Example Request:

const idea = {
  name: 'New Idea',
  author: '632b771832d29d840043f72a',
  description: '...',
  content: {
    customer: '...',
    customerJob: '...',
    customerProblem: '...',
    solution: '...',
  }
};

axios.post('https://acmecorp.launchpath.io/api/v1-beta/ideas', {
  headers: {
    Authentication: `Bearer ${process.env.LAUNCHPATH_API_TOKEN}`,
    Accept: 'application/json',
  },
  body: idea,
})