Notion Ruby Client

A Ruby client for the Notion API.

• Installation
• Usage
  • Create a New Bot Integration
  • Declare the API token
  • API Client
    • Instantiating a new Notion API client
    • Pagination
• Endpoints
  • Databases
    • Query a database
    • Create a Database
    • Update a Database
    • Retrieve a database
  • Pages
    • Retrieve a page
    • Create a page
    • Update page
    • Retrieve a page property item
  • Blocks
    • Retrieve a block
    • Update a block
    • Delete a block
    • Retrieve block children
    • Append block children
  • Comments
    • Retrieve comments
    • Create a comment on a page
    • Create a comment on a discussion
  • Users
    • Retrieve your token's bot user
    • Retrieve a user
    • List all users
  • Search
• Acknowledgements

Add to Gemfile.

gem 'notion-ruby-client'

Run bundle install.

📘 Before you start

Make sure you are an Admin user in your Notion workspace. If you're not an Admin in your current workspace, create a new personal workspace for free.

To create a new integration, follow the steps 1 & 2 outlined in the Notion documentation. The “Internal Integration Token” is what is going to be used to authenticate API calls (referred to here as the “API token”).

📘 Integrations don't have access to any pages (or databases) in the workspace at first. A user must share specific pages with an integration in order for those pages to be accessed using the API.

Notion.configure do |config|
  config.token = ENV['NOTION_API_TOKEN']
end

For Rails projects, the snippet above would go to config/application.rb.

client = Notion::Client.new

You can specify the token or logger on a per-client basis:

client = Notion::Client.new(token: '<secret Notion API token>')

The client natively supports cursor pagination for methods that allow it, such as users_list. Supply a block and the client will make repeated requests adjusting the value of start_cursor with every response. The default page size is set to 100 (Notion’s current default and maximum) and can be adjusted via Notion::Client.config.default_page_size or by passing it directly into the API call.

all_users = []
client.users_list(page_size: 25) do |page|
  all_users.concat(page.results)
end
all_users # All users, retrieved 25 at a time

When using cursor pagination the client will automatically pause and then retry the request if it runs into Notion rate limiting. (It will pause for 10 seconds before retrying the request, a value that can be overriden with Notion::Client.config.default_retry_after.) If it receives too many rate-limited responses in a row it will give up and raise an error. The default number of retries is 100 and can be adjusted via Notion::Client.config.default_max_retries or by passing it directly into the method as max_retries.

You can also proactively avoid rate limiting by adding a pause between every paginated request with the sleep_interval parameter, which is given in seconds.

all_users = []
client.users_list(sleep_interval: 5, max_retries: 20) do |page|
  # pauses for 5 seconds between each request
  # gives up after 20 consecutive rate-limited responses
  all_users.concat(page.results)
end
all_users

As of Notion-Version 2025-09-03, a database can hold multiple data sources, and querying, and property-schema changes are performed against a data source, not the database itself. Use database to look up a database's data source ids, then see Data sources below. database_query is kept for reference but the underlying endpoint is deprecated — use data_source_query instead.

Gets a paginated array of Page objects contained in the database, filtered and ordered according to the filter conditions and sort criteria provided in the request.

client.database_query(database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0')  # retrieves the first page

client.database_query(database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0', start_cursor: 'fe2cc560-036c-44cd-90e8-294d5a74cebc')

client.database_query(database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0') do |page|
  # paginate through all pages
end

# Filter and sort the database
sorts = [
  {
    'timestamp': 'created_time',
    'direction': 'ascending'
  }
]
filter = {
  'or': [
    {
      'property': 'In stock',
      'checkbox': {
        'equals': true
      }
    },
    {
      'property': 'Cost of next trip',
      'number': {
        'greater_than_or_equal_to': 2
      }
    }
  ]
}
client.database_query(database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0', sorts: sorts, filter: filter)

See Pagination for details about how to iterate through the list.

See the full endpoint documentation on Notion Developers.

Creates a database, with a single data source, as a subpage in the specified parent page, with the specified properties schema.

title = [
  {
    'type': 'text',
    'text': {
      'content': 'Grocery List',
      'link': nil
    }
  }
]
properties = {
  'Name': {
    'title': {}
  },
  'Description': {
    'rich_text': {}
  },
  'In stock': {
    'checkbox': {}
  },
  'Food group': {
    'select': {
      'options': [
        {
          'name': '🥦Vegetable',
          'color': 'green'
        },
        {
          'name': '🍎Fruit',
          'color': 'red'
        },
        {
          'name': '💪Protein',
          'color': 'yellow'
        }
      ]
    }
  }
}
client.create_database(
  parent: { page_id: '98ad959b-2b6a-4774-80ee-00246fb0ea9b' },
  title: title,
  properties: properties
)

Under the hood, the Notion API now expects the schema nested under initial_data_source: { properties: ... }. The properties: shorthand above is still accepted and wrapped automatically; you can also pass initial_data_source: directly.

See the full endpoint documentation on Notion Developers.

Updates an existing database as specified by the parameters. As of 2025-09-03 this only covers database-level fields (title, description, icon, cover, is_inline, in_trash, is_locked, parent) — use update_data_source to change the property schema.

title = [
  {
    'text': {
      'content': 'Orbit 💜 Notion'
    }
  }
]
client.update_database(database_id: 'dd428e9dd3fe4171870da7a1902c748b', title: title)

See the full endpoint documentation on Notion Developers.

Retrieves a Database object using the ID specified.

client.database(database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0')

The response's data_sources field lists the data source ids and names that belong to this database, e.g. response.data_sources.first.id, for use with the endpoints below.

See the full endpoint documentation on Notion Developers.

📘 relation property values (e.g. when setting a relation property via create_page/update_page) must reference a data_source_id as of Notion-Version 2025-09-03 — database_id is no longer accepted when writing. Reading a page back still includes both database_id and data_source_id on relation values for compatibility. The gem does not validate property payloads (for any property type), so this is a data-shape change on the caller's side, not something enforced here.

Gets a paginated array of Page objects contained in the data source, filtered and ordered according to the filter conditions and sort criteria provided in the request. This replaces database_query as of Notion-Version 2025-09-03.

database = client.database(database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0')
data_source_id = database.data_sources.first.id

client.data_source_query(data_source_id: data_source_id)  # retrieves the first page

client.data_source_query(data_source_id: data_source_id, start_cursor: 'fe2cc560-036c-44cd-90e8-294d5a74cebc')

client.data_source_query(data_source_id: data_source_id) do |page|
  # paginate through all pages
end

client.data_source_query(data_source_id: data_source_id, sorts: sorts, filter: filter)

See Pagination for details about how to iterate through the list.

See the full endpoint documentation on Notion Developers.

Adds a new data source to an existing database.

client.create_data_source(
  parent: { database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0' },
  title: title,
  properties: properties
)

See the full endpoint documentation on Notion Developers.

Updates an existing data source's title or property schema.

client.update_data_source(data_source_id: data_source_id, title: title)

See the full endpoint documentation on Notion Developers.

Retrieves a data source object using the ID specified.

client.data_source(data_source_id: data_source_id)

See the full endpoint documentation on Notion Developers.

Retrieves a Page object using the ID specified.

📘 Responses contains page properties, not page content. To fetch page content, use the retrieve block children endpoint.

client.page(page_id: 'b55c9c91-384d-452b-81db-d1ef79372b75')

See the full endpoint documentation on Notion Developers.

Creates a new page in the specified data source (or database) or as a child of an existing page.

📘 As of Notion-Version 2025-09-03, prefer parent: { data_source_id: ... } over parent: { database_id: ... }; the latter keeps working for databases with a single data source. See Data sources.

If the parent is a data source or database, the property values of the new page in the properties parameter must conform to the parent's property schema.

If the parent is a page, the only valid property is title.

The new page may include page content, described as blocks in the children parameter.

The following example creates a new page within the specified database:

properties = {
  'Name': {
    'title': [
      {
        'text': {
          'content': 'Tuscan Kale'
        }
      }
    ]
  },
  'Description': {
    'rich_text': [
      {
        'text': {
          'content': 'A dark green leafy vegetable'
        }
      }
    ]
  },
  'Food group': {
    'select': {
      'name': '🥦 Vegetable'
    }
  },
  'Price': {
    'number': 2.5
  }
}
children = [
  {
    'object': 'block',
    'type': 'heading_2',
    'heading_2': {
      'rich_text': [{
        'type': 'text',
        'text': { 'content': 'Lacinato kale' }
      }]
    }
  },
  {
    'object': 'block',
    'type': 'paragraph',
    'paragraph': {
      'rich_text': [
        {
          'type': 'text',
          'text': {
            'content': 'Lacinato kale is a variety of kale with a long tradition in Italian cuisine, especially that of Tuscany. It is also known as Tuscan kale, Italian kale, dinosaur kale, kale, flat back kale, palm tree kale, or black Tuscan palm.',
            'link': { 'url': 'https://en.wikipedia.org/wiki/Lacinato_kale' }
          }
        }
      ]
    }
  }
]
client.create_page(
   parent: { database_id: 'e383bcee-e0d8-4564-9c63-900d307abdb0'},
   properties: properties,
   children: children
)

This example creates a new page as a child of an existing page.

properties = {
  title: [
    {
      "type": "text",
      "text": {
        "content": "My favorite food",
        "link": null
      }
    }
  ]
}
children = [
  {
    'object': 'block',
    'type': 'heading_2',
    'heading_2': {
      'rich_text': [{
        'type': 'text',
        'text': { 'content': 'Lacinato kale' }
      }]
    }
  },
  {
    'object': 'block',
    'type': 'paragraph',
    'paragraph': {
      'rich_text': [
        {
          'type': 'text',
          'text': {
            'content': 'Lacinato kale is a variety of kale with a long tradition in Italian cuisine, especially that of Tuscany. It is also known as Tuscan kale, Italian kale, dinosaur kale, kale, flat back kale, palm tree kale, or black Tuscan palm.',
            'link': { 'url': 'https://en.wikipedia.org/wiki/Lacinato_kale' }
          }
        }
      ]
    }
  }
]
client.create_page(
   parent: { page_id: 'feb1cdfaab6a43cea4ecbc9e8de63ef7'},
   properties: properties,
   children: children
)

See the full endpoint documentation on Notion Developers.

Updates page property values for the specified page. Properties that are not set via the properties parameter will remain unchanged.

If the parent is a database, the new property values in the properties parameter must conform to the parent database's property schema.

properties = {
  'In stock': {
    'checkbox': true
  }
}
client.update_page(page_id: 'b55c9c91-384d-452b-81db-d1ef79372b75', properties: properties)

To move a page to the trash, or restore it, set in_trash:

client.update_page(page_id: 'b55c9c91-384d-452b-81db-d1ef79372b75', in_trash: true)

📘 As of Notion-Version 2026-03-11, the archived field is renamed to in_trash on pages, databases, data sources and blocks, in both requests and responses.

See the full endpoint documentation on Notion Developers.

Retrieves a property_item object for a given page_id and property_id. Depending on the property type, the object returned will either be a value or a paginated list of property item values. See Property item objects for specifics.

To obtain property_id's, use the Retrieve a database endpoint.

client.page_property_item(
  page_id: 'b55c9c91-384d-452b-81db-d1ef79372b75',
  property_id: 'aBcD123'
)

See the full endpoint documentation on Notion Developers.

Retrieves a Block object using the ID specified.

📘 If a block contains the key has_children: true, use the Retrieve block children endpoint to get the list of children

client.block(block_id: '9bc30ad4-9373-46a5-84ab-0a7845ee52e6')

See the full endpoint documentation on Notion Developers.

Updates the content for the specified block_id based on the block type. Supported fields based on the block object type (see Block object for available fields and the expected input for each field).

Note The update replaces the entire value for a given field. If a field is omitted (ex: omitting checked when updating a to_do block), the value will not be changed.

to_do = {
  'rich_text': [{
    'type': 'text',
    'text': { 'content': 'Lacinato kale' }
    }],
  'checked': false
}
client.update_block(block_id: '9bc30ad4-9373-46a5-84ab-0a7845ee52e6', 'to_do' => to_do)

See the full endpoint documentation on Notion Developers.

Sets a Block object, including page blocks, to in_trash: true using the ID specified. Note: in the Notion UI application, this moves the block to the "Trash" where it can still be accessed and restored.

To restore the block with the API, use the Update a block or Update page respectively.

client.delete_block(block_id: '9bc30ad4-9373-46a5-84ab-0a7845ee52e6')

See the full endpoint documentation on Notion Developers.

Returns a paginated array of child block objects contained in the block using the ID specified. In order to receive a complete representation of a block, you may need to recursively retrieve the block children of child blocks.

client.block_children(block_id: 'b55c9c91-384d-452b-81db-d1ef79372b75')

client.block_children(block_id: 'b55c9c91-384d-452b-81db-d1ef79372b75', start_cursor: 'fe2cc560-036c-44cd-90e8-294d5a74cebc')

client.block_children(block_id: 'b55c9c91-384d-452b-81db-d1ef79372b75') do |page|
  # paginate through all children
end

See Pagination for details about how to iterate through the list.

See the full endpoint documentation on Notion Developers.

Creates and appends new children blocks to the parent block specified by block_id.

Returns a paginated list of newly created first level children block objects.

children = [
  {
    "object": 'block',
    "type": 'heading_2',
    'heading_2': {
      'rich_text': [{
        'type': 'text',
        'text': { 'content': 'A Second-level Heading' }
      }]
    }
  }
]
client.block_append_children(block_id: 'b55c9c91-384d-452b-81db-d1ef79372b75', children: children)

By default children are appended at the end of the parent. Use position to insert them elsewhere:

# after a specific block
client.block_append_children(
  block_id: 'b55c9c91-384d-452b-81db-d1ef79372b75',
  position: { type: 'after_block', after_block: { id: '9bc30ad4-9373-46a5-84ab-0a7845ee52e6' } },
  children: children
)

# at the beginning of the parent
client.block_append_children(block_id: 'b55c9c91-384d-452b-81db-d1ef79372b75', position: { type: 'start' }, children: children)

📘 As of Notion-Version 2026-03-11, position replaces the flat after parameter, which is no longer accepted. Also, the transcription block type is renamed to meeting_notes.

See the full endpoint documentation on Notion Developers.

client.retrieve_comments(block_id: '1a2f70ab26154dc7a838536a3f430af4')

options = {
  parent: { page_id: '3e4bc91d36c74de595113b31c6fdb82c' },
  rich_text: [
    {
      text: {
        content: 'Hello world'
      }
    }
  ]
}
client.create_comment(options)

options = {
  discussion_id: 'ea116af4839c410bb4ac242a18dc4392',
  rich_text: [
    {
      text: {
        content: 'Hello world'
      }
    }
  ]
}
client.create_comment(options)

See the full endpoint documention on Notion Developers.

Retrieves the bot User associated with the API token provided in the authorization header. The bot will have an owner field with information about the person who authorized the integration.

client.me

See the full endpoint documentation on Notion Developers.

Retrieves a User using the ID specified.

client.user(user_id: 'd40e767c-d7af-4b18-a86d-55c61f1e39a4')

See the full endpoint documentation on Notion Developers.

Returns a paginated list of Users for the workspace.

client.users_list # retrieves the first page

client.users_list(start_cursor: 'fe2cc560-036c-44cd-90e8-294d5a74cebc')

client.users_list do |page|
  # paginate through all users
end

See Pagination for details about how to iterate through the list.

See the full endpoint documentation on Notion Developers.

Searches all pages and child pages that are shared with the integration. The results may include data sources.

📘 As of Notion-Version 2025-09-03, the filter value 'database' is replaced by 'data_source', and matching results are returned as "object": "data_source" (one per data source, so a database with multiple data sources yields multiple results) instead of "object": "database". Code that filters search results by object == 'database' needs to check for 'data_source' instead.

client.search # search through every available page and data source

client.search(query: 'Specific query') # limits which pages are returned by comparing the query to the page title

client.search(filter: { property: 'object', value: 'page' }) # only returns pages

client.search(filter: { property: 'object', value: 'data_source' }) # only returns data sources

client.search(sort: { direction: 'ascending', timestamp: 'last_edited_time' }) # sorts the results based on the provided criteria.

client.search(start_cursor: 'fe2cc560-036c-44cd-90e8-294d5a74cebc')

client.search do |page|
  # paginate through all search pages
end

See Pagination for details about how to iterate through the list.

See the full endpoint documentation on Notion Developers.

The code, specs and documentation of this gem are an adaptation of the fantastic Slack Ruby Client gem. Many thanks to its author and maintainer @dblock and contributors.