Notion API - Public Beta (English)
    Notion API - Public Beta (English)
    • Introduction
    • Integration capabilities
    • Request limits
    • Status codes
    • ENDPOINTS
      • Authentication
        • Authentication
        • Token
      • Blocks
        • Delete a block
        • Append block children
        • Retrieve a block
        • Update a block
        • Retrieve block children
      • Databases
        • Filter database entries
        • Sort database entries
        • Update database properties
        • Retrieve a database
        • Update a database
        • Query a database
      • Pages
        • Archive a page
        • Retrieve a page property item
        • Create a page
        • Retrieve a Page
        • Update Page properties
      • Users
        • List all users
        • Retrieve your token's bot user
        • Retrieve a user
      • Comments
        • Create comment
        • Retrieve comments
      • Search
        • Search optimizations and limitations
        • Search by title
    • OBJECTS
      • Block
      • Comment
      • Unfurl attribute object for Link Previews
      • Page
        • Page
        • Page properties
      • Database
        • Database
        • Database properties
      • User
        • User
        • Comment
      • Other
        • Emoji object
        • File object
        • Parent object
        • Rich text object
    • Versioning
      • Versioning
      • Changes by version
    • ENDPOINTS Copy
      • Authentication
        • Authentication
        • Token
      • Blocks
        • Retrieve a block
        • Update a block
        • Retrieve block children
        • Delete a block
        • Append block children
      • Databases
        • Filter database entries
        • Sort database entries
        • Update database properties
        • Retrieve a database
        • Update a database
        • Query a database
        • Create a database
      • Pages
        • Archive a page
        • Retrieve a Page
        • Update Page properties
        • Retrieve a page property item
        • Create a page
      • Users
        • Retrieve a user
        • List all users
        • Retrieve your token's bot user
      • Comments
        • Create comment
        • Retrieve comments

    Introduction

    Introduction#

    The reference is your key to a comprehensive understanding of the Notion API.
    Integrations use the API to access Notion's pages, databases, and users. Integrations can connect services to Notion and build interactive experiences for users within Notion. Using the navigation on the left, you'll find details for objects and endpoints used in the API.

    📘#

    You need an integration token to interact with the Notion API. You can find an integration token after you create an integration on the integration settings page. If this is your first look at the Notion API, we recommend beginning with the Getting started guide to learn how to create an integration.
    If you want to work on a specific integration, but can't access the token, confirm that you are an admin in the associated workspace. You can check inside the Notion UI via Settings & Members in the left sidebar. If you're not an admin in any of your workspaces, you can create a personal workspace for free.

    Conventions#

    The base URL to send all API requests is https://api.notion.com. HTTPS is required for all API requests.
    The Notion API follows RESTful conventions when possible, with most operations performed via GET, POST, PATCH, and DELETE requests on page and database resources. Request and response bodies are encoded as JSON.

    JSON conventions#

    Top-level resources have an "object" property. This property can be used to determine the type of the resource (e.g. "database", "user", etc.)
    Top-level resources are addressable by a UUIDv4 "id" property. You may omit dashes from the ID when making requests to the API, e.g. when copying the ID from a Notion URL.
    Property names are in snake_case (not camelCase or kebab-case).
    Temporal values (dates and datetimes) are encoded in ISO 8601 strings. Datetimes will include the time value (2020-08-12T02:12:33.231Z) while dates will include only the date (2020-08-12)
    The Notion API does not support empty strings. To unset a string value for properties like a url Property value object, for example, use an explicit null instead of "".

    Code samples & SDKs#

    Samples requests and responses are shown for each endpoint. Requests are shown using the Notion JavaScript SDK, and cURL. These samples make it easy to copy, paste, and modify as you build your integration.
    Notion SDKs are open source projects that you can install to easily start building. You may also choose any other language or library that allows you to make HTTP requests.

    Pagination#

    Endpoints that return lists of objects support cursor-based pagination requests. By default, Notion returns ten items per API call. If the number of items in a response from a support endpoint exceeds the default, then an integration can use pagination to request a specific set of the results and/or to limit the number of returned items.

    Supported endpoints#

    HTTP methodEndpoint
    GETList all users
    GETRetrieve block children
    GETRetrieve a comment
    GETRetrieve a page property item
    POSTQuery a database
    POSTSearch

    Responses#

    If an endpoint supports pagination, then the response object contains the below fields.
    FieldTypeDescription
    has_morebooleanWhether the response includes the end of the list. false if there are no more results. Otherwise, true.
    next_cursorstringA string that can be used to retrieve the next page of results by passing the value as the start_cursor parameter to the same endpoint. Only available when has_more is true.
    object"list"The constant string "list".
    resultsarray of objectsThe list, or partial list, of endpoint-specific results. Refer to a supported endpoint's individual documentation for details.
    type"block" "comment" "database" "page" "page_or_database" "property_item" "user"A constant string that represents the type of the objects in results.
    {type}paginated list objectAn object containing type-specific pagination information. For property_items, the value corresponds to the paginated page property type. For all other types, the value is an empty object.

    Parameters for paginated requests#

    🚧Parameter location varies by endpoint#

    GET requests accept parameters in the query string.
    POST requests receive parameters in the request body.
    ParameterTypeDescription
    page_sizenumberThe number of items from the full list to include in the response. Default: 100 Maximum: 100 The response may contain fewer than the default number of results.
    start_cursorstringA next_cursor value returned in a previous response. Treat this as an opaque value. Defaults to undefined, which returns results from the beginning of the list.

    How to send a paginated request#

    1.
    Send an initial request to the supported endpoint.
    2.
    Retrieve the next_cursor value from the response (only available when has_more is true).
    3.
    Send a follow up request to the endpoint that includes the next_cursor param in either the query string (for GET requests) or in the body params (POST requests).

    Example: request the next set of query results from a database#

    cURL
    curl --location --request POST 'https://api.notion.com/v1/databases/<database_id>/query' \
--header 'Authorization: Bearer <secret_bot>' \
--header 'Content-Type: application/json' \
--data '{
    "start_cursor": "33e19cb9-751f-4993-b74d-234d67d0d534"
}'
    Modified at 2023-04-28 05:55:30
    Next
    Integration capabilities
    Built with