Records

standards records covers CRUD and full-text search on every object your key can read, records attach-document uploads a file onto a record in one call (see Files and documents), and records access shares a private record with other members.

ListCopy Anchor Link

standards records list contacts --limit 20 --sort createdAt:desc

The response is { data, page }. Pipe it through jq .data to work on the rows.

standards records list contacts --filter '{"combinator":"and","rules":[{"attribute":"status","operator":"is","value":"active"}]}' --count exact

GetCopy Anchor Link

standards records get contacts <recordId>

CreateCopy Anchor Link

standards records create contacts --data '{"firstName":"Alice","email":"[email protected]"}'

Single-quote the JSON so the shell keeps the double quotes.

On a hierarchical object, --parent <id> creates the record under that parent. A parent is set only at creation: update refuses it, and move changes it.

standards records create notes --data '{"title":"Kickoff"}' --parent <parentRecordId>

UpdateCopy Anchor Link

update sends a PUT. The API validates the merged record, so send only the attributes that change.

standards records update contacts <recordId> --data '{"firstName":"Alicia"}'

DeleteCopy Anchor Link

standards records delete contacts <recordId>

The command prints Record <id> deleted. and nothing else.

To see what a delete would take first, deletion-count counts it for up to 100 records. It answers { incomingReferences, descendants }: the links from other records the delete would break, and the sub-records beyond the ones you name that would go to the trash with them.

standards records deletion-count notes <recordId> <otherRecordId>

Move a recordCopy Anchor Link

On a hierarchical object, move puts a record and its sub-records under another parent, and move-impact shows first who would gain and lose access. Both take exactly one of --parent <id> or --top-level: neither, or both, is refused before a request is sent.

standards records move-impact notes <recordId> --parent <newParentId>
standards records move notes <recordId> --parent <newParentId>
standards records move notes <recordId> --top-level

The subtree takes the access of its new top-level record. move does not send the impact back, so it is not refused when the sharing changed after move-impact was read: run the two back to back. Who may move a record, and every refusal, is on Sharing.

SearchCopy Anchor Link

--query is required. The other flags are the ones list takes.

standards records search contacts --query "alice" --limit 10

standards records search contacts --query "alice" --sort updatedAt:desc --count estimated

ExportCopy Anchor Link

Download the records as CSV, with the columns you name, in that order. --columns is required; the filter and sort flags are the ones list takes.

standards records export deals --columns name,stage,amount --sort name:asc -o deals.csv

Besides the object's attributes, --columns accepts the four system columns createdAt, updatedAt, createdBy and lastUpdatedBy. The times are written as YYYY-MM-DD HH:mm in --timezone, and the actors by display name. Any other name fails with Unknown export columns, and nothing is written.

An export covers at most 100 000 records. A larger match prints the EXPORT_TOO_LARGE error, writes nothing and exits non-zero: narrow it with --filter and run it again.

Set a logoCopy Anchor Link

Set a record's image to the logo of a company's domain. The domain can be a website or a bare domain: https://www.Acme.com reads as acme.com.

standards records set-logo companies <recordId> acme.com

The logo counts as an image a person chose, so no later change to the record's data replaces it. The record's icon and any previous image are removed. When the domain is not one, or no logo is known for it, the command prints SCHEMA_VALIDATION_FAILED and exits non-zero.

Attach a documentCopy Anchor Link

Upload a local file and attach it to a record in one call.

standards records attach-document contacts <recordId> --file ./contract.pdf

standards records attach-document contacts <recordId> --file ./contract.pdf --attribute contract --title "Signed contract"

The response is the created document. Read its files and text with Documents and files.

AccessCopy Anchor Link

Share a private record with named members of the workspace, each as a reader or an editor. See Sharing for what each level allows.

standards records access list deals <recordId>
standards records access grant deals <recordId> <actorId> --role reader
standards records access revoke deals <recordId> <actorId>
standards records access clear deals <recordId>

grant, revoke and clear print the audience after the change. Only the owner or an editor of a private record can share it, and a workspace record is refused with RECORD_GRANT_ON_WORKSPACE.

Meetings of a recordCopy Anchor Link

standards meetings for-record <recordId> lists the meetings a record's email addresses appear in. It takes the filters of meetings list (--search, --since, --before, --addresses, --order, --limit, --offset), plus:

standards meetings for-record <recordId> --email-attributes <attributeId> --count exact

Next stepsCopy Anchor Link

• Documents and files: manage the pack you just created.
• Objects and records: what a record is and how filters address attributes.
• Sharing: what a reader and an editor may do, and every refusal.
• CLI: output formats, exit codes and shell pitfalls.
• Book a demo