Skip to main content
GET
/
orgs
/
{org_id}
/
tables
/
{table_id}
Get a table
curl --request GET \
  --url https://api.useinvent.com/orgs/{org_id}/tables/{table_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "Companies",
  "description": "Companies are organizations that own and manage other organizations.",
  "record_prefix": "LEAD",
  "display_field_id": "<string>",
  "archived": true,
  "fields": [
    {
      "id": "<string>",
      "table_id": "<string>",
      "key": "<string>",
      "schema": {
        "name": "<string>",
        "description": "<string>",
        "optional": true,
        "array": true,
        "placeholder": "<string>",
        "display": {},
        "order": 1,
        "link": "<string>",
        "metadata": {},
        "allowed_modes": [],
        "broadcast_hidden": true,
        "broadcast_field": true,
        "integration_field": true,
        "display_field": true,
        "conditions": [
          {
            "field": "<string>",
            "value": "<unknown>"
          }
        ],
        "hidden": true,
        "picker": {
          "views": [],
          "selectable_mime_types": [
            "<string>"
          ]
        },
        "disable_variables": true,
        "allowed_types": [
          "<string>"
        ],
        "visibility": "PRIVATE"
      },
      "readonly": true
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.useinvent.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

​
org_id
string
required

Org ID

​
table_id
string
required

Table ID

Response

200 - application/json
​
id
string
required
​
type
enum<string>
required
Available options:
custom,
contacts,
chats,
users
​
name
string | null
required

The name of the table.

Example:

"Companies"

​
description
string | null
required

The description of the table.

Example:

"Companies are organizations that own and manage other organizations."

​
record_prefix
string | null
required

The prefix of the record.

Example:

"LEAD"

​
display_field_id
string | null
required

The id of the display field.

​
archived
boolean
required

Whether the table is archived.

​
fields
object[]
required
​
created_at
string<date-time> | null
required
​
updated_at
string<date-time> | null
required