API ReferenceFunctions

/public/functions/{functionId}

GET
/public/functions/{functionId}

Path Parameters

functionId*string

Header Parameters

X-API-Version?string

Response Body

curl -X GET "https://companion-api.napster.com/public/functions/string"
{
  "id": "string",
  "organizationId": "string",
  "initializationRequired": true,
  "data": {
    "name": "string",
    "description": "string",
    "parameters": {
      "type": "string",
      "description": "string",
      "properties": {
        "property1": null,
        "property2": null
      },
      "required": [
        "string"
      ]
    }
  },
  "flow": "implicit",
  "url": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "receiveMessages": true,
  "prompt": "string",
  "tags": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "code": "string",
  "description": "string",
  "type": "failure",
  "numericType": 0
}