Get Database

Use Case

Use this endpoint to read the database object itself, including title, description, parent, and property schema.

Endpoint

Permissions

Requires databases.read and access to the database.

Parameters

Response Example

{
  "object": "database",
  "id": "66666666-6666-4666-8666-666666666666",
  "created_time": "2026-04-09T08:00:00.000Z",
  "last_edited_time": "2026-04-09T09:30:00.000Z",
  "created_by": {
    "object": "user",
    "id": "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb"
  },
  "last_edited_by": {
    "object": "user",
    "id": "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb"
  },
  "title": [
    {
      "type": "text",
      "text": {
        "content": "Task Board",
        "link": null
      },
      "plain_text": "Task Board",
      "href": null
    }
  ],
  "description": [],
  "icon": null,
  "cover": null,
  "parent": {
    "type": "page_id",
    "page_id": "55555555-5555-4555-8555-555555555555"
  },
  "properties": {
    "Name": {
      "id": "title",
      "type": "title",
      "name": "Name"
    },
    "Status": {
      "id": "16161616-1616-4616-8616-161616161616",
      "type": "select",
      "name": "Status"
    }
  },
  "in_trash": false,
  "is_inline": false,
  "url": "https://buildin.ai/database/66666666-6666-4666-8666-666666666666"
}

Behavior

• The response returns schema under properties; records are not included.
• Use the query endpoint to list database records.
• The V2 model keeps properties directly on database and does not introduce a separate data source object.

Errors

• 401 unauthorized: invalid or expired token.
• 403 forbidden: missing databases.read or no access.
• 404 not_found: database does not exist.

Related Docs

Prerequisites

• Authentication and Scopes

Next Steps

• Query Database
• Update Database

References

• Object Models
• Page Property Models