Craft

App · 20 actions

Organize Craft documents and folders, append Markdown, search notes, and manage tasks.

Actions

ActionWhat it does
Add taskCreate a task in your inbox, a document, or a daily note.
Append MarkdownAppend formatted text to a document or daily note.
Create collectionAdd a structured table at the end of a document.
Create documentCreate a document in the space or in a folder.
Create folderCreate a folder at the root of the space or inside another folder.
Delete blocksRemove the specified blocks from a document.
Delete foldersDelete the selected folders.
Delete tasksDelete the tasks identified by the supplied IDs.
Get connection detailsGet the connected space, its time zone, and link templates.
Get document contentRead a document or page and its nested blocks.
List collection itemsRead the rows and their properties from a collection.
List collectionsFind the collections available in selected documents or across the space.
List documentsList documents in the connected space, a folder, or a built-in location.
List foldersGet the space's folder tree and built-in document locations.
List tasksList tasks in a document, the inbox, the logbook, or the space.
Move documentsMove documents to a folder, Unsorted, or Templates.
Move documents to trashMove the selected documents into the space's trash.
Search in documentFind text in one document, with optional surrounding blocks.
Update block textReplace the text of an existing block and keep its other settings.
Update taskChange the task's text, state, schedule date, or deadline.

Add task

Create a task in your inbox, a document, or a daily note.

Inputs

MarkdownmarkdowntextRequired
Enter the text or Markdown.
LocationlocationtextRequired
Choose where to create the task.One of: inbox, dailyNote, document.
Documentdocument_idtext
Choose the document when using document location.
Daily note datedaily_note_datedate
Choose the date when using daily note location.
Schedule dateschedule_datedate
Choose the date to work on the task.
Deadline datedeadline_datedate
Choose when the task is due.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "id": "example",
        "location": {},
        "markdown": "example",
        "taskInfo": {}
      }
    ]
  }
}

Append Markdown

Append formatted text to a document or daily note.

Inputs

MarkdownmarkdowntextRequired
Enter the text or Markdown.
Documentdocument_idtext
Choose the document or page to append to.
Daily note datedaily_note_datedate
Choose a daily note date instead of a document.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "id": "example",
        "markdown": "example",
        "type": "example"
      }
    ]
  }
}

Create collection

Add a structured table at the end of a document.

Inputs

Documentdocument_idtextRequired
Choose the document to hold the collection.
NamenametextRequired
Enter a name for the collection.
Column namescolumn_nameslist
Enter names for additional columns.
Column typecolumn_typetext
Choose the field type for the additional columns.One of: text, date, number, checkbox. Default: text.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "collectionBlockId": "example",
    "name": "example",
    "schema": {}
  }
}

Create document

Create a document in the space or in a folder.

Inputs

TitletitletextRequired
Enter the document title.
Folderfolder_idtext
Choose a folder, or leave empty to create it in Unsorted.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "clickableLink": "example",
        "id": "example",
        "title": "example"
      }
    ]
  }
}

Create folder

Create a folder at the root of the space or inside another folder.

Inputs

NamenametextRequired
Enter the folder name.
Parent folderparent_folder_idtext
Choose the parent folder.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "id": "example",
        "name": "example"
      }
    ]
  }
}

Delete blocks

Remove the specified blocks from a document.

Inputs

Block IDSblock_idslistRequired
Enter the IDs of the blocks to delete.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "id": "example"
      }
    ]
  }
}

Delete folders

Delete the selected folders. Use empty folders for test runs.

Inputs

Folder IDSfolder_idslistRequired
Choose the folders to delete.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "id": "example"
      }
    ]
  }
}

Delete tasks

Delete the tasks identified by the supplied IDs.

Inputs

Task IDStask_idslistRequired
Enter the IDs from Add task or List tasks.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "id": "example"
      }
    ]
  }
}

Get connection details

Get the connected space, its time zone, and link templates.

Inputs

None.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "space": {
      "id": "example",
      "name": "example",
      "timezone": "example"
    },
    "urlTemplates": {},
    "utc": {}
  }
}

Get document content

Read a document or page and its nested blocks.

Inputs

Documentdocument_idtextRequired
Choose a document or enter the ID of a nested page.
Max depthmax_depthnumber
Limit how deeply nested blocks are included.At least -1.
Fetch metadatafetch_metadatatrue/false
Include block creation and edit information.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "content": [
      {}
    ],
    "id": "example",
    "markdown": "example",
    "title": "example",
    "type": "example"
  }
}

List collection items

Read the rows and their properties from a collection.

Inputs

Collection IDcollection_idtextRequired
Enter an ID from List collections.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "properties": {},
        "title": "example"
      }
    ]
  }
}

List collections

Find the collections available in selected documents or across the space.

Inputs

Document IDSdocument_idslist
Limit the search to these documents.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "id": "example",
        "name": "example"
      }
    ]
  }
}

List documents

List documents in the connected space, a folder, or a built-in location.

Inputs

Locationlocationtext
Choose a built-in document location.One of: unsorted, trash, templates, daily_notes (Daily notes).
Folderfolder_idtext
Choose a folder to list.
Fetch metadatafetch_metadatatrue/false
Include creation and last-modified information.
Start datestart_datedate
Include documents created on or after this date.
End dateend_datedate
Include documents created on or before this date.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "createdAt": "example",
        "dailyNoteDate": "example",
        "id": "example",
        "lastModifiedAt": "example",
        "title": "example"
      }
    ]
  }
}

List folders

Get the space's folder tree and built-in document locations.

Inputs

None.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "folders": [
          {}
        ],
        "id": "example",
        "name": "example"
      }
    ]
  }
}

List tasks

List tasks in a document, the inbox, the logbook, or the space.

Inputs

ScopescopetextRequired
Choose where to look for tasks.One of: active, upcoming, inbox, logbook, document, all.
Documentdocument_idtext
Choose a document when looking in a document.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "id": "example",
        "location": {},
        "markdown": "example",
        "taskInfo": {}
      }
    ]
  }
}

Move documents

Move documents to a folder, Unsorted, or Templates. This can restore documents from the trash.

Inputs

Document IDSdocument_idslistRequired
Choose the documents to move or trash.
Folderfolder_idtext
Choose the destination folder.
Locationlocationtext
Choose a built-in destination instead of a folder.One of: unsorted, templates.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "destination": {},
        "id": "example"
      }
    ]
  }
}

Move documents to trash

Move the selected documents into the space's trash.

Inputs

Document IDSdocument_idslistRequired
Choose the documents to move or trash.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "id": "example"
      }
    ]
  }
}

Search in document

Find text in one document, with optional surrounding blocks.

Inputs

Documentdocument_idtextRequired
Choose the document to search.
PatternpatterntextRequired
Enter a search pattern. Regular expressions are supported.
Case sensitivecase_sensitivetrue/false
Match uppercase and lowercase exactly.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {}
    ]
  }
}

Update block text

Replace the text of an existing block and keep its other settings.

Inputs

Block IDblock_idtextRequired
Enter the block ID from Append Markdown or Get document content.
MarkdownmarkdowntextRequired
Enter the text or Markdown.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "id": "example",
        "markdown": "example",
        "type": "example"
      }
    ]
  }
}

Update task

Change the task's text, state, schedule date, or deadline.

Inputs

Task IDtask_idtextRequired
Enter the ID from Add task or List tasks.
Markdownmarkdowntext
Enter the text or Markdown.
Statestatetext
Choose the new task state.One of: todo, done, canceled.
Schedule dateschedule_datedate
Choose the date to work on the task.
Deadline datedeadline_datedate
Choose when the task is due.

Outputs

dataobject
The response from Craft.
Example output
{
  "data": {
    "items": [
      {
        "id": "example"
      }
    ]
  }
}

On this page