> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Notion: Retrieve A Block

> Retrieve a block. Notion Retrieve A Block reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Retrieve a block.

<Info>
  Tool ID: `notion_retrieve_a_block`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'notion_retrieve_a_block',
  {
    "block_id": "block_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={null}
deepline tools execute notion_retrieve_a_block --input '{
  "block_id": "block_123"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "object": "block",
    "id": "123e4567-e89b-42d3-a456-426614174000"
  }
}
```

Use `deepline tools get notion_retrieve_a_block --json` for the latest machine-readable contract.

## Input reference

Retrieve a block

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.block_id` | `string` | Yes | — | — |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieve a block",
    "properties": {
      "block_id": {
        "type": "string"
      }
    },
    "required": [
      "block_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.object` | `"block"` | Yes | — | — |
| `result.data.id` | `string` | Yes | — | — |
| `result.data.type` | `"paragraph"` | Yes | — | — |
| `result.data.paragraph` | `object` | Yes | — | — |
| `result.data.paragraph.rich_text` | `array` | Yes | — | — |
| `result.data.paragraph.rich_text[].plain_text` | `string` | Yes | — | The plain text content of the rich text object, without any styling. |
| `result.data.paragraph.rich_text[].href` | `string \| null` | Yes | — | A URL that the rich text object links to or mentions. |
| `result.data.paragraph.rich_text[].annotations` | `object` | Yes | — | — |
| `result.data.paragraph.rich_text[].annotations.bold` | `boolean` | Yes | — | — |
| `result.data.paragraph.rich_text[].annotations.italic` | `boolean` | Yes | — | — |
| `result.data.paragraph.rich_text[].annotations.strikethrough` | `boolean` | Yes | — | — |
| `result.data.paragraph.rich_text[].annotations.underline` | `boolean` | Yes | — | — |
| `result.data.paragraph.rich_text[].annotations.code` | `boolean` | Yes | — | — |
| `result.data.paragraph.rich_text[].annotations.color` | `"default" \| "gray" \| "brown" \| "orange" \| "yellow" \| "green" \| "blue" \| "purple" \| "pink" \| "red" \| "default_background" \| "gray_background" \| "brown_background" \| "orange_background" \| "yellow_background" \| "green_background" \| "blue_background" \| "purple_background" \| "pink_background" \| "red_background"` | Yes | — | — |
| `result.data.paragraph.rich_text[].type` | `"text"` | Yes | — | Always `text` |
| `result.data.paragraph.rich_text[].text` | `object` | Yes | — | If a rich text object's type value is `text`, then the corresponding text field contains an object including the text content and any inline link. |
| `result.data.paragraph.rich_text[].text.content` | `string` | Yes | — | The actual text content of the text. |
| `result.data.paragraph.rich_text[].text.link` | `object \| null` | Yes | — | An object with information about any inline link in this text, if included. |
| `result.data.paragraph.rich_text[].text.link.url` | `string` | Yes | — | The URL of the link. |
| `result.data.paragraph.rich_text[].mention` | `object` | Yes | — | Mention objects represent an inline mention of a database, date, link preview mention, page, template mention, or user. A mention is created in the Notion UI when a user types `@` followed by the name of the reference. |
| `result.data.paragraph.rich_text[].mention.type` | `"user"` | Yes | — | Always `user` |
| `result.data.paragraph.rich_text[].mention.user` | `object` | Yes | — | — |
| `result.data.paragraph.rich_text[].mention.date` | `object` | Yes | — | — |
| `result.data.paragraph.rich_text[].mention.link_preview` | `object` | Yes | — | — |
| `result.data.paragraph.rich_text[].mention.link_mention` | `object` | Yes | — | — |
| `result.data.paragraph.rich_text[].mention.page` | `object` | Yes | — | Details of the page mention. |
| `result.data.paragraph.rich_text[].mention.database` | `object` | Yes | — | Details of the database mention. |
| `result.data.paragraph.rich_text[].mention.template_mention` | `object` | Yes | — | — |
| `result.data.paragraph.rich_text[].mention.custom_emoji` | `object` | Yes | — | — |
| `result.data.paragraph.rich_text[].equation` | `object` | Yes | — | Notion supports inline LaTeX equations as rich text objects with a type value of `equation`. |
| `result.data.paragraph.rich_text[].equation.expression` | `string` | Yes | — | A KaTeX compatible string. |
| `result.data.paragraph.color` | `"default" \| "gray" \| "brown" \| "orange" \| "yellow" \| "green" \| "blue" \| "purple" \| "pink" \| "red" \| "default_background" \| "gray_background" \| "brown_background" \| "orange_background" \| "yellow_background" \| "green_background" \| "blue_background" \| "purple_background" \| "pink_background" \| "red_background"` | Yes | — | — |
| `result.data.paragraph.icon` | `object \| null` | Yes | — | — |
| `result.data.paragraph.icon.type` | `"emoji"` | Yes | — | Type of icon. In this case, an emoji. |
| `result.data.paragraph.icon.emoji` | `string` | Yes | — | — |
| `result.data.paragraph.icon.file` | `object` | Yes | — | — |
| `result.data.paragraph.icon.file.url` | `string` | Yes | — | The URL of the file. |
| `result.data.paragraph.icon.file.expiry_time` | `string` | Yes | — | The time when the URL will expire. |
| `result.data.paragraph.icon.external` | `object` | Yes | — | The external URL for the icon. |
| `result.data.paragraph.icon.external.url` | `string` | Yes | — | The URL of the external file or resource. |
| `result.data.paragraph.icon.custom_emoji` | `object` | Yes | — | — |
| `result.data.paragraph.icon.custom_emoji.id` | `string` | Yes | — | — |
| `result.data.paragraph.icon.custom_emoji.name` | `string` | Yes | — | The name of the custom emoji. |
| `result.data.paragraph.icon.custom_emoji.url` | `string` | Yes | — | The URL of the custom emoji. |
| `result.data.paragraph.icon.icon` | `object` | Yes | — | — |
| `result.data.paragraph.icon.icon.name` | `string` | Yes | — | — |
| `result.data.paragraph.icon.icon.color` | `"gray" \| "lightgray" \| "brown" \| "yellow" \| "orange" \| "green" \| "blue" \| "purple" \| "pink" \| "red"` | Yes | — | — |
| `result.data.parent` | `object` | Yes | — | — |
| `result.data.parent.type` | `"database_id"` | Yes | — | The parent type. |

The table shows the first 50 fields. Use the live contract below for every field.

<Info>
  This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get notion_retrieve_a_block --json`.
</Info>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Notion provider guide](/docs/providers/notion/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.