Skip to main content

Table Object

Example
{
"id": "63a1f65623aaf6bcb564b00b",
"name": "Teams",
"solution": "63a1f65523aaf6bcb564b00a",
"slug": "teams",
"status": "active",
"structure": [
{
"slug": "name",
"label": "Name",
"field_type": "textfield",
"params": {
...
}
}
],
"primary_field": "name",
"order": 100,
"structure_layout": null,
"show_all_reports_members": [],
"fields_metadata": {},
"permissions": {
"level": "all_members",
"members": [],
"teams": []
},
"field_permissions": [],
"first_created": {
"by": "63a1f65723aaf6bcb564b1f1",
"on": "2022-12-20T17:52:22.646000Z"
},
"settings": {
"emails": false,
"meeting_notes": false,
"call_log": false
}
}

Object Literals​

ParamTypeNullableDescription
idstringNoThe unique Table Id.
namestringNoThe Table (App) display name.
solutionstringNoThe Id of the Table's Solution.
slugstringNoThe Table slug (SmartSuite internal use).
statusstringNoThe Table's status.
structurearray of objectsNoArray of field objects (see Field Object).
primary_fieldstringNoSlug of the Table's Title (Primary) field.
ordernumberNoSort position of the Table within its Solution's table list.
structure_layoutobjectYes
show_all_reports_membersarrayNo
fields_metadataobjectNo
permissionsobjectYesPermissions object, or null when the Table inherits its Solution's permissions.
field_permissionsarrayNoArray of field permissions objects.
first_createdobjectNoFirst created object {by, on}. on may be null; by is a member Id, or an expanded member object when hydrated is requested.
settingsobjectNoTable settings object