Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Api / Notions

Method Description
🔹 create() Create notion
🔹 delete() Delete notion
🔹 read() Fetch notion
🔹 search() Search notions
🔹 update() Update notion

📚 Notions API Reference

Getting started

// Place your API Key 👇 here
$sdk = new \Kronup\Sdk();

// API Call
$sdk->api()->notions();

create()

Define a notion

#️⃣ Execute example in terminal

php -f create.php

Request

POST /notions

Type signature

(new \Kronup\Sdk())->api()->notions()->create(
    \Kronup\Model\PayloadNotionCreate $payload_notion_create
): \Kronup\Model\Notion

Parameters

Name Type Description
$payload_notion_create \Kronup\Model\PayloadNotionCreate  

Return type

\Kronup\Model\Notion

🔺 Back to top


delete()

Delete a notion model. This also removes the associated Experiences for all users in this Organization.

#️⃣ Execute example in terminal

php -f delete.php

Request

DELETE /notions/{notionId}

Type signature

(new \Kronup\Sdk())->api()->notions()->delete(
    string $notion_id
): bool

Parameters

Name Type Description
$notion_id string Notion ID

Return type

bool

🔺 Back to top


read()

Retrieve notion model

#️⃣ Execute example in terminal

php -f read.php

Request

GET /notions/{notionId}

Type signature

(new \Kronup\Sdk())->api()->notions()->read(
    string $notion_id
): \Kronup\Model\Notion

Parameters

Name Type Description
$notion_id string Notion ID

Return type

\Kronup\Model\Notion

🔺 Back to top


Get a list of notion models

#️⃣ Execute example in terminal

php -f search.php

Request

GET /notions

Type signature

(new \Kronup\Sdk())->api()->notions()->search(
    [ string $search_term, ]
    [ int $page_number = 1, ]
    [ int $page_size = 500 ]
): \Kronup\Model\NotionsList

Parameters

Name Type Description
$search_term string Search term
$page_number int [default to 1]
$page_size int [default to 500]

Return type

\Kronup\Model\NotionsList

🔺 Back to top


update()

Update notion

#️⃣ Execute example in terminal

php -f update.php

Request

POST /notions/{notionId}

Type signature

(new \Kronup\Sdk())->api()->notions()->update(
    string $notion_id,
    \Kronup\Model\PayloadNotionUpdate $payload_notion_update
): \Kronup\Model\Notion

Parameters

Name Type Description
$notion_id string Notion ID
$payload_notion_update \Kronup\Model\PayloadNotionUpdate  

Return type

\Kronup\Model\Notion

🔺 Back to top