Detail API

This document explains how to use the API to get the details of a single record in a table.

Interface Description

Get detailed information about a specified record in a table.

Request Method

GET /api/bases/{base_id}/tables/{table_name}/records/{record_id}

Path Parameters

Parameter	Type	Description
base_id	string	Base ID
table_name	string	Table name
record_id	string	Record ID

Query Parameters

Parameter	Type	Description	Default Value
fields	string	List of fields to return, separated by commas	*

Request Header

x-bm-token: your_api_token

Example Requests

Basic Query

GET /api/bases/base123/tables/table456/records/rec789

Specifying Fields

GET /api/bases/base123/tables/table456/records/rec789?fields=id,name,created_at

Response Format

Successful Response

{
  "id": "11",
  "name": "test",
  "created_by": "usrIL1t20OwVvW9jXzT",
  "updated_by": "usrIL1t20OwVvW9jXzT",
  "created_at": "2024-11-20T17:30:12.000Z",
  "updated_at": "2024-11-20T17:30:27.000Z",
  "creator": {
    "id": "usrIL1t20OwVvW9jXzT",
    "email": "[email protected]",
    "name": "Dylan"
  },
  "modifier": {
    "id": "usrIL1t20OwVvW9jXzT",
    "email": "[email protected]",
    "name": "Dylan"
  }
}

Error Response

{
  "message": "Record not found",
}

Field Type Explanation

The return format for different types of fields:

Basic Type

{
  "text_field": "text content",
  "number_field": 123.45,
  "boolean_field": true,
  "date_field": "2023-01-01T00:00:00Z"
}

Option Type

{
  "single_select": "option 1",
  "multiple_select": [
    "option 1",
    "option 2"
  ]
}

Association Type

{
  "single_link": {
    "id": "rec123",
    "name": "associated record"
  },
  "multiple_link": [
    {
      "id": "rec123",
      "name": "associated record 1"
    },
    {
      "id": "rec456",
      "name": "associated record 2"
    }
  ]
}

Creator

{
  "created_by": "usrIL1t20OwVvW9jXzT",
  "creator": {
    "id": "usrIL1t20OwVvW9jXzT",
    "email": "[email protected]",
    "name": "Dylan"
  }
}

Updater

{
  "updated_by": "usrIL1t20OwVvW9jXzT",
  "modifier": {
    "id": "usrIL1t20OwVvW9jXzT",
    "email": "[email protected]",
    "name": "Dylan"
  }
}

Notes

1. If the record does not exist, a 404 error will be returned