Record Object

A Record is an individual item in a Table. Records are the basic unit of data that are pulled into various views and dashboards. Each Record can include data in multiple fields.

The Records in a Table pull everything together, holding a series of values - one for each Field in the Table. Every Record has a Title Field, which acts like a label or identifier. All the Record's Fields can be viewed and edited by users with appropriate permissions.

System Fields

The following fields are included in every record's structure. Additional fields added to the Table are identified by their slug value as the key, with values varying by field type.

Param	Type	Description
id	string	(read only) Unique Id of the Record.
application_id	string	(read only) The Table Id.
title	string	The primary (title) field.
first_created	date object	(read only) object containing by (Member Id) and on (ISO datetime) values indicating when the record was first created.
last_updated	date object	(read only) object containing by (Member Id) and on (ISO datetime) values indicating when the record was last updated.
autonumber	number	The record's auto number value.
ranking	ranking object	(read only) Record's "rank" which is used to order records in the grid.
order	number	Numeric value used to order tables.
application_slug	string	(read only) The Table slug value.
deleted_date	deleted date object	Date record was deleted. object containing date (ISO datetime), null if not deleted.
comments_count	number	Count of record comments.
followed_by	array of strings	Array containing Ids of Members who follow the record.

Example Record JSON

{
    "first_created": {
        "by": "5fa01dedaa4e41222745cbab",
        "on": "2024-12-05T18:39:25.961000Z"
    },
    "last_updated": {
        "by": "5fa01dedaa4e41222745cbab",
        "on": "2024-12-05T18:40:31.804000Z"
    },
    "application_id": "6716999c6b87f8d761d72bdf",
    "autonumber": 2,
    "ranking": {
        "default": "aaaaaabdpg"
    },
    "id": "6751f35d3f08d70b76217f1e",
    "application_slug": "st5ogy0y",
    "deleted_date": {
        "date": null
    },
    "title": "test2",
    "comments_count": 0,
    "description": "test text",
    "assigned_to": [],
    "status": {
        "value": "backlog",
        "updated_on": "2024-12-05T18:39:26.446000Z"
    },
    "due_date": {
        "from_date": {
            "date": null,
            "include_time": false
        },
        "to_date": {
            "date": null,
            "include_time": false
        },
        "status_is_completed": false,
        "status_updated_on": null
    },
    "priority": "",
    "followed_by": []
}

SimpleRecord Interface

export interface SimpleRecord {
  id: ID;
  title: string;
  [key: string]: any;
}