API Documentation

GET /objectives

Fetches a list of objectives associated to the account. The account is determined by the API key.

Parameters

id

required

The id of the roadmap to add the card to. If missing a 400 error will be returned.

Resource URL

GET https://api.prodpad.com/v1/objectives

Response

Status: 200 OK

[
   {
       "id": "58656ef6-1cec-4bab-befa-ab7e6b77e59a",
       "name": "User Growth",
       "state": "active",
       "product": null,
       "created_at": "2018-12-10 15:55:49",
       "updated_at": "2018-12-10 15:55:49"
   },
   {
       "id": "d1be931d-07d4-491f-99b6-1b5233581992",
       "name": "Engagement",
       "state": "active",
       "product": {
           "id": 1
       },
       "created_at": "2018-12-10 15:55:49",
       "updated_at": "2018-12-10 15:55:49"
   },
   {
       "id": "1aff7f5f-4f2f-4ec8-a948-8c2c2e3a3ece",
       "name": "Enterprise",
       "state": "active",
       "product": {
           "id": 1
       },
       "created_at": "2018-12-10 15:55:49",
       "updated_at": "2018-12-10 15:55:49"
   },
   {
       "id": "e9604e0e-64e6-40b1-a130-a217e105bc03",
       "name": "Revenue",
       "state": "active",
       "product": null,
       "created_at": "2018-12-10 15:55:49",
       "updated_at": "2018-12-10 15:55:49"
   }
]

Notes:

  • All dates are in UTC

GET /objectives/:id

Returns a specific objective.

Resource URL

GET https://api.prodpad.com/v1/objectives/:id

Response

Status: 200 OK

[
   {
       "id": "e9604e0e-64e6-40b1-a130-a217e105bc03",
       "name": "Revenue",
       "state": "active",
       "product": null,
       "created_at": "2018-12-10 15:55:49",
       "updated_at": "2018-12-10 15:55:49"
   }
]

Notes:

  • All dates are in UTC

Comments