API v1

Added Getting started

Every read answers the QUERY method

Every endpoint that answers GET now also answers QUERY at the same address. Send the parameters in a JSON or form body instead of the address, and the answer is the one GET gives. A parameter sent both in the address and in the body answers 422. Each of those answers carries an Accept-Query header naming the body formats.

Why it changed

A long search or filter no longer has to fit in the address, and it stays out of the logs that record addresses.

Changes

Field Change Endpoints
QUERY Added
QUERY /admin/support-requests
QUERY /admin/support-requests/{supportRequest}
QUERY /api-keys
QUERY /api-keys/{apiKey}
QUERY /billing
QUERY /billing/payments
QUERY /billing/payments/{payment}
QUERY /emails-sent
QUERY /emails-sent/{emailSent}
QUERY /entity-types
QUERY /entity-types/{entityType}
QUERY /exports
QUERY /exports/{accountExport}
QUERY /exports/{accountExport}/download
QUERY /imports/{accountImport}
QUERY /imports/{accountImport}/contacts
QUERY /imports/{accountImport}/report
QUERY /life-event-categories
QUERY /life-event-categories/{lifeEventCategory}
QUERY /life-event-categories/{lifeEventCategory}/types
QUERY /life-event-types
QUERY /life-event-types/{lifeEventType}
QUERY /life-event-types/{lifeEventType}/fields
QUERY /locations
QUERY /locations/{location}
QUERY /logs
QUERY /logs/{log}
QUERY /mcp-calls
QUERY /mcp-calls/{mcpCall}
QUERY /me
QUERY /notification-channels
QUERY /notification-channels/{channel}
QUERY /notification-preferences
QUERY /notifications
QUERY /notifications/{notification}
QUERY /possession-conditions
QUERY /possession-conditions/{possessionCondition}
QUERY /possession-tags
QUERY /possession-tags/{possessionTag}
QUERY /possession-types
QUERY /possession-types/{possessionType}
QUERY /possession-types/{possessionType}/export
QUERY /relationship-categories
QUERY /relationship-categories/{relationshipCategory}
QUERY /relationship-categories/{relationshipCategory}/types
QUERY /relationship-types
QUERY /relationship-types/{relationshipType}
QUERY /status
QUERY /support-requests
QUERY /support-requests/{supportRequest}
QUERY /support-requests/{supportRequest}/attachments/{attachment}/content
QUERY /templates
QUERY /templates/{template}
QUERY /templates/{template}/versions
QUERY /templates/{template}/versions/{version}
QUERY /vaults
QUERY /vaults/{vault}
QUERY /vaults/{vault}/contact-categories
QUERY /vaults/{vault}/contact-list-columns
QUERY /vaults/{vault}/contacts
QUERY /vaults/{vault}/contacts/me
QUERY /vaults/{vault}/contacts/{contact}
QUERY /vaults/{vault}/contacts/{contact}/groups
QUERY /vaults/{vault}/contacts/{contact}/markdown
QUERY /vaults/{vault}/contacts/{contact}/merge/{other}
QUERY /vaults/{vault}/contacts/{contact}/name-representations
QUERY /vaults/{vault}/contacts/{contact}/relationships
QUERY /vaults/{vault}/contacts/{contact}/relationships/{relationship}
QUERY /vaults/{vault}/contacts/{contact}/reminder-occurrences
QUERY /vaults/{vault}/contacts/{contact}/reminders
QUERY /vaults/{vault}/contacts/{contact}/reminders/{reminder}
QUERY /vaults/{vault}/contacts/{contact}/vcard
QUERY /vaults/{vault}/duplicates
QUERY /vaults/{vault}/entity-types/{entityType}/entities
QUERY /vaults/{vault}/groups
QUERY /vaults/{vault}/groups/{group}
QUERY /vaults/{vault}/groups/{group}/files
QUERY /vaults/{vault}/groups/{group}/files/{file}
QUERY /vaults/{vault}/groups/{group}/files/{file}/content
QUERY /vaults/{vault}/groups/{group}/life-events
QUERY /vaults/{vault}/groups/{group}/members
QUERY /vaults/{vault}/groups/{group}/notes
QUERY /vaults/{vault}/groups/{group}/notes/{note}
QUERY /vaults/{vault}/groups/{group}/reminder-occurrences
QUERY /vaults/{vault}/groups/{group}/reminders
QUERY /vaults/{vault}/groups/{group}/reminders/{reminder}
QUERY /vaults/{vault}/knowledge/folders
QUERY /vaults/{vault}/knowledge/lists
QUERY /vaults/{vault}/knowledge/lists/{list}
QUERY /vaults/{vault}/knowledge/notes
QUERY /vaults/{vault}/knowledge/notes/{note}
QUERY /vaults/{vault}/knowledge/search
QUERY /vaults/{vault}/life-events
QUERY /vaults/{vault}/life-events/{lifeEvent}
QUERY /vaults/{vault}/possessions
QUERY /vaults/{vault}/possessions/{possession}
QUERY /vaults/{vault}/possessions/{possession}/insurance-records
QUERY /vaults/{vault}/possessions/{possession}/insurance-records/{insuranceRecord}
QUERY /vaults/{vault}/possessions/{possession}/loans
QUERY /vaults/{vault}/possessions/{possession}/loans/{loan}
QUERY /vaults/{vault}/possessions/{possession}/location-stays
QUERY /vaults/{vault}/possessions/{possession}/location-stays/{stay}
QUERY /vaults/{vault}/possessions/{possession}/maintenance-records
QUERY /vaults/{vault}/possessions/{possession}/maintenance-records/{maintenanceRecord}
QUERY /vaults/{vault}/possessions/{possession}/provenance
QUERY /vaults/{vault}/possessions/{possession}/provenance/{event}
QUERY /vaults/{vault}/possessions/{possession}/transactions
QUERY /vaults/{vault}/possessions/{possession}/transactions/{transaction}
QUERY /vaults/{vault}/possessions/{possession}/valuations
QUERY /vaults/{vault}/possessions/{possession}/valuations/{valuation}
QUERY /vaults/{vault}/reminder-occurrences
QUERY /vaults/{vault}/search