Get ActivityPlan by ID

curl --request GET \
  --url https://platform.kodexa.ai/api/activity-plans/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://platform.kodexa.ai/api/activity-plans/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.kodexa.ai/api/activity-plans/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.kodexa.ai/api/activity-plans/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/activity-plans/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleted": true,
  "deprecated": true,
  "description": "<string>",
  "id": "<string>",
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "steps": null,
  "template": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "defaultDescriptionTemplate": "<string>",
  "defaultTitleTemplate": "<string>",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deletedDate": "2023-11-07T05:31:56Z",
  "documentFamilyGroups": null,
  "documentSummarizationPrompt": "<string>",
  "documentValidationPrompt": "<string>",
  "extensionPackRef": "<string>",
  "inputOptions": null,
  "inputsSchema": null,
  "knowledgeAgent": true,
  "metadata": null,
  "orgSlug": "<string>",
  "organization": {
    "id": "<string>"
  },
  "ref": "<string>",
  "type": "<string>",
  "uri": "<string>",
  "yamlSource": "<string>"
}

GET

api

activity-plans

{id}

Get ActivityPlan by ID

curl --request GET \
  --url https://platform.kodexa.ai/api/activity-plans/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://platform.kodexa.ai/api/activity-plans/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.kodexa.ai/api/activity-plans/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.kodexa.ai/api/activity-plans/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/activity-plans/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "changeSequence": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleted": true,
  "deprecated": true,
  "description": "<string>",
  "id": "<string>",
  "name": "<string>",
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "steps": null,
  "template": true,
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "defaultDescriptionTemplate": "<string>",
  "defaultTitleTemplate": "<string>",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deletedDate": "2023-11-07T05:31:56Z",
  "documentFamilyGroups": null,
  "documentSummarizationPrompt": "<string>",
  "documentValidationPrompt": "<string>",
  "extensionPackRef": "<string>",
  "inputOptions": null,
  "inputsSchema": null,
  "knowledgeAgent": true,
  "metadata": null,
  "orgSlug": "<string>",
  "organization": {
    "id": "<string>"
  },
  "ref": "<string>",
  "type": "<string>",
  "uri": "<string>",
  "yamlSource": "<string>"
}

Authorizations

x-api-key

string

header

required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

string<uuid>

required

Unique identifier (UUID) of the resource.

Response

The ActivityPlan

changeSequence

integer<int32>

required

createdOn

string<date-time>

required

deleted

boolean

required

deprecated

boolean

required

description

string

required

string

required

name

string

required

organizationId

string

required

publicAccess

boolean

required

slug

string

required

steps

unknown

required

template

boolean

required

updatedOn

string<date-time>

required

uuid

string

required

defaultDescriptionTemplate

string

defaultTitleTemplate

string

deleteUserEmail

string | null

deleteUserId

string | null

deletedDate

string<date-time> | null

documentFamilyGroups

unknown

documentSummarizationPrompt

string

documentValidationPrompt

string

extensionPackRef

string

inputOptions

unknown

inputsSchema

unknown

knowledgeAgent

boolean | null

metadata

unknown

orgSlug

string

organization

object | null

Show child attributes

ref

string

type

string

uri

string

Computed resource URI (scheme://orgSlug/slug), present on serialized responses.

yamlSource

string | null