Skip to content

Help center/Tables & records

Create a table from the CLI

Design structured tables, choose field types and read the records you need.

Before you start

Connect the CLI and find the target application ID. Your account needs editor or creator access to the application. A default key follows those permissions, so you can continue adding fields and records to the table you create without configuring another grant.

Review developer key permissions

Create an application first

For a new project, check auth whoami for the connected tenant and team, then capabilities for apps.create. Check auth permissions with resourceType TEAM and your team ID to confirm creation access. A missing capability is a feature limitation, not a permission denial.

Create an empty application
cynexio app create --name "Issue tracker" --dry-run --profile work
cynexio app create --name "Issue tracker" --idempotency-key create-issue-tracker-001 --profile work
cynexio app get --id <returned-app-id> --profile work

The application is created in the connected team and starts empty. Default keys and user sessions follow the current user’s team membership. Legacy keys limited to existing resources cannot create applications. Use the returned application ID to create tables below.

Preview and create an empty table

Create an Orders table
cynexio table create --app 1234567890123456789 \
  --name Orders --dry-run --profile work
cynexio table create --app 1234567890123456789 \
  --name Orders --idempotency-key create-orders-001 --profile work

Review the dry-run result before executing. The created table has no fields or records. Use its returned table ID to create your name or identifier field first; this becomes the key field (isKey). Add the remaining fields afterward. Reuse the same idempotency key for retries of this same intended write.

Add a basic number field

Create and inspect a field
cynexio field create --table 2234567890123456789 \
  --name Amount --type number --field-config '{"precision":2}' \
  --idempotency-key amount-field-001 --profile work
cynexio field list --table 2234567890123456789 --profile work

Replace the table ID with the one you just created. Use field list to obtain the field IDs required for record values and queries. Run field types for the schema, value and analysis capability matrix. Selects, people, one-way and reciprocal relations and validated formula fields are supported. Attachment and button columns support schema configuration only.

Create calculations with the Formula guide

Read a selected set of records

Save the following as query.json, replacing the field ID with your Amount field. This query selects the amount and keeps records whose amount is at least 100.00.

query.json
{
  "limit": 100,
  "select": ["3234567890123456789"],
  "filter": {
    "op": "gte",
    "fieldId": "3234567890123456789",
    "value": "100.00"
  }
}
Read the snapshot
cynexio record list --table 2234567890123456789 \
  --data @query.json --all --profile work

An empty table returns no records. --all reads pages from the same bounded snapshot; inspect completeness metadata before treating the result as the full dataset. Validated formula fields can read authorized dependencies within the calculation limits; relations return record IDs without expanding rows.