Tables
List tables
List the tables defined for an org.
GET
List tables
Authorizations
Bearer token authentication using your API key
Query Parameters
Available options:
custom, contacts, chats, users Search tables by name.
Maximum string length:
256Filter by visibility. ACTIVE excludes archived (default), ARCHIVED returns only archived, ALL returns both.
Available options:
ACTIVE, ARCHIVED, ALL Page number
Number of items to take
Next page token (Only used on special endpoints)
Response
200 - application/json
Available options:
custom, contacts, chats, users The name of the table.
Example:
"Companies"
The description of the table.
Example:
"Companies are organizations that own and manage other organizations."
The picked icon. Null renders the default table icon.
The picked icon tint. Null renders the default color.
Available options:
red, orange, amber, yellow, lime, green, teal, cyan, sky, blue, indigo, violet, purple, fuchsia, pink, rose, neutral The id of the display field.
Whether the table is archived.
Manual display order within the org.
- Option 1
- Option 2