Retrieve

GET

http://localhost:3000/api/v2/value-propositions/VP-1

Request

Header Params

Authorization

string

required

Example:

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTM5OSwiZmlyc3ROYW1lIjoiRGluZXNoIiwibGFzdE5hbWUiOiJSYXdhdCIsInVzZXJFeHBlcmllbmNlIjpudWxsLCJlbWFpbCI6ImRyYXdhdEBzaG9ydGVybG9vcC5jb20iLCJkaXNwbGF5TmFtZSI6IkRpbmVzaCBSYXdhdCIsInByb2ZpbGVJbWFnZSI6Imh0dHBzOi8vbGgzLmdvb2dsZXVzZXJjb250ZW50LmNvbS9hL0FDZzhvY0pUdWdvbEpIal9HUEFielJIYU01akJCeEt1Tm5GZnBxekExMGpsYVRkd2NITW5kZz1zOTYtYyIsInRpbWVab25lQWJiciI6bnVsbCwic3RhdHVzIjoiYWN0aXZlIiwicHJvdmlkZXIiOiJnb29nbGUiLCJ0ZXJtc0FjY2VwdGVkIjoxLCJsYXN0UGFnZSI6Ii9TU1MvcHJvZHVjdC9EUkEvZGFzaGJvYXJkIiwidmVyaWZpY2F0aW9uVG9rZW4iOiJleUpoYkdjaU9pSklVekkxTmlJc0luUjVjQ0k2SWtwWFZDSjkuZXlKbGJXRnBiQ0k2SW1SeVlYZGhkRUJ6YUc5eWRHVnliRzl2Y0M1amIyMGlMQ0pwWkNJNk1UTTVPU3dpZEdsdFpTSTZJakl3TWpRdE1EWXRNamRVTURRNk1qTTZNREF1TURBNVdpSXNJblI1Y0dVaU9pSkpUbFpKVkVVaUxDSnpkV0p6WTNKcGNIUnBiMjVKWkNJNk1UQTJNeXdpZEdWaGJVbGtJam9pTXpnNUlpd2lhV0YwSWpveE56RTVORFl5TVRnd0xDSmxlSEFpT2pFM01qY3lNemd4T0RCOS5nSVpyNzVfV1BtLXNZbE1zamdpUGo1S3ZQNlZiZEwxUEVKQ05OWlFyLWxjIiwibGFzdFNpZ25JbiI6IjIwMjQtMDYtMjlUMDU6MTI6MzYuMDAwWiIsInJvbGUiOiJzdXBlcmFkbWluIiwiaXNQcm9kZWFzeUFkbWluIjowLCJncm91cCI6MSwicmVmZXJyZXIiOm51bGwsImlzVmVyaWZpZWQiOjEsInJlZmVycmVyVG9rZW4iOm51bGwsInJlZnJlc2hSZWZlcnJlclRva2VuIjpudWxsLCJiaW8iOm51bGwsImNyZWF0ZWRBdCI6IjIwMjMtMTItMTdUMDE6NDk6NDMuMDAwWiIsInVwZGF0ZWRBdCI6IjIwMjQtMDYtMjlUMDU6MTI6MzYuMDAwWiIsInN1YnNjcmlwdGlvbiI6eyJ1c2VyUm9sZSI6InN1cGVyYWRtaW4iLCJzdWJzY3JpcHRpb25FeHRlcm5hbEtleSI6IlNTUyIsImV4dGVybmFsS2V5IjoiU1NTIiwiY25hbWUiOm51bGwsImlkIjoxMDYzfSwic3Vic2NyaXB0aW9uSWQiOjEwNjMsImV4dGVybmFsS2V5IjoiU1NTIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJTU1MiLCJ0aW1lIjoiMjAyNC0wOC0xMFQwNDo0OTozOC45NTVaIiwiaWF0IjoxNzIzMjY1Mzc4LCJleHAiOjE3MzEwNDEzNzh9.5NP6xMoEi0z0yADIGoE99PcoSfAmoPq_qgWos4fQMR8

Content-Type

string

required

Example:

application/json

initiativeId

string

required

Example:

DRA

subscriptionId

string

required

Example:

SSS

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'http://localhost:3000/api/v2/value-propositions/VP-1' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MTM5OSwiZmlyc3ROYW1lIjoiRGluZXNoIiwibGFzdE5hbWUiOiJSYXdhdCIsInVzZXJFeHBlcmllbmNlIjpudWxsLCJlbWFpbCI6ImRyYXdhdEBzaG9ydGVybG9vcC5jb20iLCJkaXNwbGF5TmFtZSI6IkRpbmVzaCBSYXdhdCIsInByb2ZpbGVJbWFnZSI6Imh0dHBzOi8vbGgzLmdvb2dsZXVzZXJjb250ZW50LmNvbS9hL0FDZzhvY0pUdWdvbEpIal9HUEFielJIYU01akJCeEt1Tm5GZnBxekExMGpsYVRkd2NITW5kZz1zOTYtYyIsInRpbWVab25lQWJiciI6bnVsbCwic3RhdHVzIjoiYWN0aXZlIiwicHJvdmlkZXIiOiJnb29nbGUiLCJ0ZXJtc0FjY2VwdGVkIjoxLCJsYXN0UGFnZSI6Ii9TU1MvcHJvZHVjdC9EUkEvZGFzaGJvYXJkIiwidmVyaWZpY2F0aW9uVG9rZW4iOiJleUpoYkdjaU9pSklVekkxTmlJc0luUjVjQ0k2SWtwWFZDSjkuZXlKbGJXRnBiQ0k2SW1SeVlYZGhkRUJ6YUc5eWRHVnliRzl2Y0M1amIyMGlMQ0pwWkNJNk1UTTVPU3dpZEdsdFpTSTZJakl3TWpRdE1EWXRNamRVTURRNk1qTTZNREF1TURBNVdpSXNJblI1Y0dVaU9pSkpUbFpKVkVVaUxDSnpkV0p6WTNKcGNIUnBiMjVKWkNJNk1UQTJNeXdpZEdWaGJVbGtJam9pTXpnNUlpd2lhV0YwSWpveE56RTVORFl5TVRnd0xDSmxlSEFpT2pFM01qY3lNemd4T0RCOS5nSVpyNzVfV1BtLXNZbE1zamdpUGo1S3ZQNlZiZEwxUEVKQ05OWlFyLWxjIiwibGFzdFNpZ25JbiI6IjIwMjQtMDYtMjlUMDU6MTI6MzYuMDAwWiIsInJvbGUiOiJzdXBlcmFkbWluIiwiaXNQcm9kZWFzeUFkbWluIjowLCJncm91cCI6MSwicmVmZXJyZXIiOm51bGwsImlzVmVyaWZpZWQiOjEsInJlZmVycmVyVG9rZW4iOm51bGwsInJlZnJlc2hSZWZlcnJlclRva2VuIjpudWxsLCJiaW8iOm51bGwsImNyZWF0ZWRBdCI6IjIwMjMtMTItMTdUMDE6NDk6NDMuMDAwWiIsInVwZGF0ZWRBdCI6IjIwMjQtMDYtMjlUMDU6MTI6MzYuMDAwWiIsInN1YnNjcmlwdGlvbiI6eyJ1c2VyUm9sZSI6InN1cGVyYWRtaW4iLCJzdWJzY3JpcHRpb25FeHRlcm5hbEtleSI6IlNTUyIsImV4dGVybmFsS2V5IjoiU1NTIiwiY25hbWUiOm51bGwsImlkIjoxMDYzfSwic3Vic2NyaXB0aW9uSWQiOjEwNjMsImV4dGVybmFsS2V5IjoiU1NTIiwic3Vic2NyaXB0aW9uRXh0ZXJuYWxLZXkiOiJTU1MiLCJ0aW1lIjoiMjAyNC0wOC0xMFQwNDo0OTozOC45NTVaIiwiaWF0IjoxNzIzMjY1Mzc4LCJleHAiOjE3MzEwNDEzNzh9.5NP6xMoEi0z0yADIGoE99PcoSfAmoPq_qgWos4fQMR8' \
--header 'Authorization;' \
--header 'initiativeId: DRA' \
--header 'initiativeId;' \
--header 'subscriptionId: SSS'

Responses

🟢200OK

application/json

Body

success

boolean

required

message

string

required

data

object

required

integer

required

externalKey

string

required

valuePropositionName

string

required

commentCount

integer

required

totalExperiments

integer

required

persona

object

required

cards

array [object {12}]

required

assets

null

required

Example

{
  "success": true,
  "message": "string",
  "data": {
    "id": 0,
    "externalKey": "string",
    "valuePropositionName": "string",
    "commentCount": 0,
    "totalExperiments": 0,
    "persona": {
      "id": 0,
      "image": null,
      "initiative": {
        "uniqueKey": null
      },
      "persona_elements": [
        {
          "id": 0,
          "label": "string",
          "description": "string"
        }
      ]
    },
    "cards": [
      {
        "id": 0,
        "cardElementKey": "string",
        "description": "string",
        "order": 0,
        "color": null,
        "favourite": true,
        "totalExperiment": 0,
        "provenExperiment": 0,
        "personaId": null,
        "importance": null,
        "uncertainty": null,
        "opportunity": {
          "id": 0,
          "description": "string",
          "externalKey": "string",
          "userId": "string",
          "color": "string",
          "urls": "string",
          "spread": "string",
          "intensity": "string",
          "progress": "string"
        }
      }
    ],
    "assets": null
  }
}

Modified at 2024-09-03 07:31:08

Create

Retrieve categories with templates