System Collections Reference
Every system collection the platform defines, with its API path, tenant-scoped and read-only flags and key fields — generated from the runtime system-collection registry.
Every system collection the platform defines — the metadata behind collections, fields, users,
security, UI, flows and audit — generated from the runtime’s system-collection registry.
Each is served like a user collection at its API path (JSON:API, see
JSON:API Conventions), and
GET /api/collections/{name}/schema describes its fields.
- Tenant-scoped — rows belong to one tenant and are isolated by row-level security.
- Read-only — the API serves reads only (audit logs, history, platform-written data).
- Key fields — the display field, then every required field.
95 system collections, sorted by name.
Collections#
| Name | Display name | Purpose | API path | Tenant-scoped | Read-only | Key fields |
|---|---|---|---|---|---|---|
analytics-events | Analytics Events | — | /api/analytics-events | yes | yes | display eventType |
api-operations | API Operations | — | /api/api-operations | yes | yes | required syntheticOpId, httpMethod, pathTemplate |
api-specs | API Specs | — | /api/api-specs | yes | no | display name; required specVersion, sourceType, rawSpec, rawFormat, parsedSpec, specHash |
approval-instances | Approval Instances | — | /api/approval-instances | yes | no | required approvalProcessId, collectionId, recordId, submittedBy, currentStepNumber, status, submittedAt |
approval-processes | Approval Processes | — | /api/approval-processes | yes | no | display name; required collectionId |
approval-step-instances | Approval Step Instances | — | /api/approval-step-instances | no | no | required approvalInstanceId, stepId, assignedTo, status |
approval-steps | Approval Steps | — | /api/approval-steps | no | no | display name; required approvalProcessId, stepNumber, approverType |
attachments | Attachments | — | /api/attachments | yes | no | display fileName; required collectionId, recordId, contentType, uploadedBy |
bulk-job-results | Bulk Job Results | — | /api/bulk-job-results | no | yes | required bulkJobId, recordIndex, status |
bulk-jobs | Bulk Jobs | — | /api/bulk-jobs | yes | no | required collectionId, operation, status |
campaign-recipients | Campaign Recipients | — | /api/campaign-recipients | yes | yes | display email; required status |
campaigns | Email Campaigns | — | /api/campaigns | yes | yes | display name; required subject, targetCollection, recipientEmailField, status |
chat-conversations | Chat Conversations | — | /api/chat-conversations | yes | no | display subject; required status, origin |
chat-messages | Chat Messages | — | /api/chat-messages | yes | no | display id; required conversationId, senderType, kind, body |
chat-participants | Chat Participants | — | /api/chat-participants | yes | no | display id; required conversationId, role |
chat-queues | Chat Queues | — | /api/chat-queues | yes | no | display name |
collection-versions | Collection Versions | — | /api/collection-versions | no | yes | required collectionId, version |
collections | Collections | — | /api/collections | yes | no | display name; required currentVersion |
connected-app-tokens | Connected App Tokens | — | /api/connected-app-tokens | no | no | required connectedAppId, tokenHash, scopes, issuedAt, expiresAt |
connected-apps | Connected Apps | — | /api/connected-apps | yes | no | display name; required clientId, clientSecretHash |
credential-oauth-tokens | Credential OAuth Tokens | — | /api/credential-oauth-tokens | yes | yes | — |
credentials | Credentials | — | /api/credentials | yes | no | display name; required type |
dashboard-components | Dashboard Components | — | /api/dashboard-components | yes | no | required dashboardId, componentType, columnPosition, rowPosition, sortOrder |
dashboards | Dashboards | — | /api/dashboards | yes | no | display name |
delegated-admin-scopes | Delegated Admin Scopes | — | /api/delegated-admin-scopes | yes | no | display name |
email-logs | Email Logs | — | /api/email-logs | yes | yes | required recipientEmail, subject, status |
email-suppressions | Email Suppressions | — | /api/email-suppressions | yes | yes | display email; required reason |
email-templates | Email Templates | — | /api/email-templates | yes | no | display name; required subject, bodyHtml |
field-history | Field History | — | /api/field-history | yes | yes | required collectionId, recordId, fieldName, changedBy, changeSource |
field-versions | Field Versions | — | /api/field-versions | no | yes | required collectionVersionId, fieldId, name, type, required, active |
fields | Fields | — | /api/fields | yes | no | display name; required collectionId, type |
flow-executions | Flow Executions | — | /api/flow-executions | yes | yes | required flowId, status, startedAt |
flows | Flows | — | /api/flows | yes | no | display name; required flowType, definition, stepLogging |
global-picklists | Global Picklists | — | /api/global-picklists | yes | no | display name |
group-memberships | Group Memberships | — | /api/group-memberships | yes | no | required groupId, memberType, memberId |
job-execution-logs | Job Execution Logs | — | /api/job-execution-logs | no | yes | required jobId, status, startedAt |
layout-assignments | Layout Assignments | — | /api/layout-assignments | yes | no | required collectionId, profileId, layoutId, evaluationOrder |
layout-fields | Layout Fields | — | /api/layout-fields | yes | no | required sectionId, fieldId, sortOrder |
layout-related-lists | Layout Related Lists | — | /api/layout-related-lists | yes | no | required layoutId, relatedCollectionId, relationshipFieldId, displayColumns, sortOrder |
layout-rules | Layout Rules | — | /api/layout-rules | yes | no | display name; required layoutId, kind, whenEvents, body, sortOrder |
layout-sections | Layout Sections | — | /api/layout-sections | yes | no | required layoutId, sortOrder |
list-views | List Views | — | /api/list-views | yes | no | display name; required collectionId, columns, viewType |
login-history | Login History | — | /api/login-history | yes | yes | required userId |
mailbox-access | Mailbox Access | — | /api/mailbox-access | yes | yes | display id; required mailboxId, principalType, principalId, role |
mailbox-attachments | Mailbox Attachments | — | /api/mailbox-attachments | yes | yes | display filename; required messageId, contentType, inline, scanStatus |
mailbox-inbound-events | Mailbox Inbound Events | — | /api/mailbox-inbound-events | yes | yes | display id; required mailboxId, provider, payloadDigest, status |
mailbox-messages | Mailbox Messages | — | /api/mailbox-messages | yes | yes | display subject; required threadId, direction, kind, isBulk, isBounce |
mailbox-templates | Mailbox Templates | — | /api/mailbox-templates | yes | no | display category; required mailboxId, templateKey, autoSendEligible, requiresVerifiedSender, disclosesAccountData, active |
mailbox-threads | Mailbox Threads | — | /api/mailbox-threads | yes | yes | display subject; required mailboxId, status, priority, requesterEmail, requesterVerified, slaFirstResponseState, slaResolutionState |
mailboxes | Mailboxes | — | /api/mailboxes | yes | yes | display name; required address, webhookKey, inboundProvider, autoReplyEnabled, aiDraftEnabled, requireVerifiedSenderForAccountData, active |
migration-runs | Migration Runs | — | /api/migration-runs | yes | no | required collectionId, fromVersion, toVersion, status |
migration-steps | Migration Steps | — | /api/migration-steps | no | yes | required migrationRunId, stepNumber, operation, status |
notes | Notes | — | /api/notes | yes | no | required collectionId, recordId, content |
oidc-providers | OIDC Providers | — | /api/oidc-providers | yes | no | display name; required issuer |
package-items | Package Items | — | /api/package-items | no | no | required packageId, itemType, itemId |
packages | Packages | — | /api/packages | yes | no | display name; required version |
page-layouts | Page Layouts | — | /api/page-layouts | yes | no | display name; required collectionId |
picklist-dependencies | Picklist Dependencies | — | /api/picklist-dependencies | yes | no | required controllingFieldId, dependentFieldId, mapping |
picklist-values | Picklist Values | — | /api/picklist-values | yes | no | display label; required picklistSourceType, picklistSourceId, value |
profile-field-permissions | Profile Field Permissions | — | /api/profile-field-permissions | yes | no | required profileId, collectionId, fieldId, visibility |
profile-object-permissions | Profile Object Permissions | — | /api/profile-object-permissions | yes | no | required profileId, collectionId, canCreate, canRead, canEdit, canDelete |
profile-system-permissions | Profile System Permissions | — | /api/profile-system-permissions | yes | no | required profileId, permissionName, granted |
profiles | Profiles | — | /api/profiles | yes | no | display name |
quick-actions | Quick Actions | — | /api/quick-actions | yes | no | display label; required collectionName, actionType, context |
record-scripts | Record Scripts | — | /api/record-scripts | yes | no | display name; required collectionId, triggerType |
record-shares | Record Shares | — | /api/record-shares | yes | no | display recordId; required collectionId, sharedWithId, sharedWithType, accessLevel |
record-type-picklists | Record Type Picklists | — | /api/record-type-picklists | no | no | required recordTypeId, fieldId, availableValues |
record-types | Record Types | — | /api/record-types | yes | no | display name; required collectionId |
record-versions | Record Versions | — | /api/record-versions | yes | yes | required collectionId, recordId, versionNumber, changeType, changedBy, changeSource |
report-folders | Report Folders | — | /api/report-folders | yes | no | display name |
reports | Reports | — | /api/reports | yes | no | display name; required reportType, primaryCollectionId, columns |
saml-providers | SAML Providers | — | /api/saml-providers | yes | no | display name; required registrationId, idpEntityId, ssoUrl |
scheduled-jobs | Scheduled Jobs | — | /api/scheduled-jobs | yes | no | display name; required jobType, cronExpression |
script-execution-logs | Script Execution Logs | — | /api/script-execution-logs | yes | yes | required scriptId, status |
script-triggers | Script Triggers | — | /api/script-triggers | no | no | required scriptId, collectionId, triggerEvent |
scripts | Scripts | — | /api/scripts | yes | no | display name; required scriptType, language, sourceCode |
security-audit-logs | Security Audit Logs | — | /api/security-audit-logs | yes | yes | required eventType, eventCategory |
seo-pages | SEO Pages | — | /api/seo-pages | yes | yes | display title; required slug, published |
setup-audit-entries | Setup Audit Entries | — | /api/setup-audit-entries | yes | yes | required userId, action, section, entityType |
telehealth-appointments | Telehealth Appointments | — | /api/telehealth-appointments | yes | no | display id; required status |
telehealth-archives | Telehealth Archives | — | /api/telehealth-archives | yes | no | display id; required sourceType, sourceId, legalHold |
telehealth-availability | Telehealth Availability | — | /api/telehealth-availability | yes | no | display id; required kind, timezone |
tenants | Tenants | — | /api/tenants | no | no | display slug; required name, edition, status, ipAllowlistEnabled |
ui-menu-items | UI Menu Items | — | /api/ui-menu-items | yes | no | display label; required menuId, displayOrder, active |
ui-menus | UI Menus | — | /api/ui-menus | yes | no | display name; required isDefault, active |
ui-pages | UI Pages | — | /api/ui-pages | yes | no | display name; required path, active, published |
ui-translations | UI Translations | — | /api/ui-translations | yes | no | display key; required locale, value |
user-groups | User Groups | — | /api/user-groups | yes | no | display name; required source |
user-ui-preferences | User UI Preferences | — | /api/user-ui-preferences | yes | no | display prefKey; required userId, prefType, value |
users | Users | — | /api/users | yes | no | display email; required userType, status |
validation-rules | Validation Rules | — | /api/validation-rules | yes | no | display name; required collectionId, errorConditionFormula, errorMessage, evaluateOn, severity |
video-sessions | Video Sessions | — | /api/video-sessions | yes | no | display id; required roomName, status |
watch-targets | Watch Targets | — | /api/watch-targets | yes | no | display name; required source, externalId, active |
watches | Watches | — | /api/watches | yes | no | display id; required status |
wins | Wins | — | /api/wins | yes | no | display summary; required isPublic |