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#

NameDisplay namePurposeAPI pathTenant-scopedRead-onlyKey fields
analytics-eventsAnalytics Events—/api/analytics-eventsyesyesdisplay eventType
api-operationsAPI Operations—/api/api-operationsyesyesrequired syntheticOpId, httpMethod, pathTemplate
api-specsAPI Specs—/api/api-specsyesnodisplay name; required specVersion, sourceType, rawSpec, rawFormat, parsedSpec, specHash
approval-instancesApproval Instances—/api/approval-instancesyesnorequired approvalProcessId, collectionId, recordId, submittedBy, currentStepNumber, status, submittedAt
approval-processesApproval Processes—/api/approval-processesyesnodisplay name; required collectionId
approval-step-instancesApproval Step Instances—/api/approval-step-instancesnonorequired approvalInstanceId, stepId, assignedTo, status
approval-stepsApproval Steps—/api/approval-stepsnonodisplay name; required approvalProcessId, stepNumber, approverType
attachmentsAttachments—/api/attachmentsyesnodisplay fileName; required collectionId, recordId, contentType, uploadedBy
bulk-job-resultsBulk Job Results—/api/bulk-job-resultsnoyesrequired bulkJobId, recordIndex, status
bulk-jobsBulk Jobs—/api/bulk-jobsyesnorequired collectionId, operation, status
campaign-recipientsCampaign Recipients—/api/campaign-recipientsyesyesdisplay email; required status
campaignsEmail Campaigns—/api/campaignsyesyesdisplay name; required subject, targetCollection, recipientEmailField, status
chat-conversationsChat Conversations—/api/chat-conversationsyesnodisplay subject; required status, origin
chat-messagesChat Messages—/api/chat-messagesyesnodisplay id; required conversationId, senderType, kind, body
chat-participantsChat Participants—/api/chat-participantsyesnodisplay id; required conversationId, role
chat-queuesChat Queues—/api/chat-queuesyesnodisplay name
collection-versionsCollection Versions—/api/collection-versionsnoyesrequired collectionId, version
collectionsCollections—/api/collectionsyesnodisplay name; required currentVersion
connected-app-tokensConnected App Tokens—/api/connected-app-tokensnonorequired connectedAppId, tokenHash, scopes, issuedAt, expiresAt
connected-appsConnected Apps—/api/connected-appsyesnodisplay name; required clientId, clientSecretHash
credential-oauth-tokensCredential OAuth Tokens—/api/credential-oauth-tokensyesyes—
credentialsCredentials—/api/credentialsyesnodisplay name; required type
dashboard-componentsDashboard Components—/api/dashboard-componentsyesnorequired dashboardId, componentType, columnPosition, rowPosition, sortOrder
dashboardsDashboards—/api/dashboardsyesnodisplay name
delegated-admin-scopesDelegated Admin Scopes—/api/delegated-admin-scopesyesnodisplay name
email-logsEmail Logs—/api/email-logsyesyesrequired recipientEmail, subject, status
email-suppressionsEmail Suppressions—/api/email-suppressionsyesyesdisplay email; required reason
email-templatesEmail Templates—/api/email-templatesyesnodisplay name; required subject, bodyHtml
field-historyField History—/api/field-historyyesyesrequired collectionId, recordId, fieldName, changedBy, changeSource
field-versionsField Versions—/api/field-versionsnoyesrequired collectionVersionId, fieldId, name, type, required, active
fieldsFields—/api/fieldsyesnodisplay name; required collectionId, type
flow-executionsFlow Executions—/api/flow-executionsyesyesrequired flowId, status, startedAt
flowsFlows—/api/flowsyesnodisplay name; required flowType, definition, stepLogging
global-picklistsGlobal Picklists—/api/global-picklistsyesnodisplay name
group-membershipsGroup Memberships—/api/group-membershipsyesnorequired groupId, memberType, memberId
job-execution-logsJob Execution Logs—/api/job-execution-logsnoyesrequired jobId, status, startedAt
layout-assignmentsLayout Assignments—/api/layout-assignmentsyesnorequired collectionId, profileId, layoutId, evaluationOrder
layout-fieldsLayout Fields—/api/layout-fieldsyesnorequired sectionId, fieldId, sortOrder
layout-related-listsLayout Related Lists—/api/layout-related-listsyesnorequired layoutId, relatedCollectionId, relationshipFieldId, displayColumns, sortOrder
layout-rulesLayout Rules—/api/layout-rulesyesnodisplay name; required layoutId, kind, whenEvents, body, sortOrder
layout-sectionsLayout Sections—/api/layout-sectionsyesnorequired layoutId, sortOrder
list-viewsList Views—/api/list-viewsyesnodisplay name; required collectionId, columns, viewType
login-historyLogin History—/api/login-historyyesyesrequired userId
mailbox-accessMailbox Access—/api/mailbox-accessyesyesdisplay id; required mailboxId, principalType, principalId, role
mailbox-attachmentsMailbox Attachments—/api/mailbox-attachmentsyesyesdisplay filename; required messageId, contentType, inline, scanStatus
mailbox-inbound-eventsMailbox Inbound Events—/api/mailbox-inbound-eventsyesyesdisplay id; required mailboxId, provider, payloadDigest, status
mailbox-messagesMailbox Messages—/api/mailbox-messagesyesyesdisplay subject; required threadId, direction, kind, isBulk, isBounce
mailbox-templatesMailbox Templates—/api/mailbox-templatesyesnodisplay category; required mailboxId, templateKey, autoSendEligible, requiresVerifiedSender, disclosesAccountData, active
mailbox-threadsMailbox Threads—/api/mailbox-threadsyesyesdisplay subject; required mailboxId, status, priority, requesterEmail, requesterVerified, slaFirstResponseState, slaResolutionState
mailboxesMailboxes—/api/mailboxesyesyesdisplay name; required address, webhookKey, inboundProvider, autoReplyEnabled, aiDraftEnabled, requireVerifiedSenderForAccountData, active
migration-runsMigration Runs—/api/migration-runsyesnorequired collectionId, fromVersion, toVersion, status
migration-stepsMigration Steps—/api/migration-stepsnoyesrequired migrationRunId, stepNumber, operation, status
notesNotes—/api/notesyesnorequired collectionId, recordId, content
oidc-providersOIDC Providers—/api/oidc-providersyesnodisplay name; required issuer
package-itemsPackage Items—/api/package-itemsnonorequired packageId, itemType, itemId
packagesPackages—/api/packagesyesnodisplay name; required version
page-layoutsPage Layouts—/api/page-layoutsyesnodisplay name; required collectionId
picklist-dependenciesPicklist Dependencies—/api/picklist-dependenciesyesnorequired controllingFieldId, dependentFieldId, mapping
picklist-valuesPicklist Values—/api/picklist-valuesyesnodisplay label; required picklistSourceType, picklistSourceId, value
profile-field-permissionsProfile Field Permissions—/api/profile-field-permissionsyesnorequired profileId, collectionId, fieldId, visibility
profile-object-permissionsProfile Object Permissions—/api/profile-object-permissionsyesnorequired profileId, collectionId, canCreate, canRead, canEdit, canDelete
profile-system-permissionsProfile System Permissions—/api/profile-system-permissionsyesnorequired profileId, permissionName, granted
profilesProfiles—/api/profilesyesnodisplay name
quick-actionsQuick Actions—/api/quick-actionsyesnodisplay label; required collectionName, actionType, context
record-scriptsRecord Scripts—/api/record-scriptsyesnodisplay name; required collectionId, triggerType
record-sharesRecord Shares—/api/record-sharesyesnodisplay recordId; required collectionId, sharedWithId, sharedWithType, accessLevel
record-type-picklistsRecord Type Picklists—/api/record-type-picklistsnonorequired recordTypeId, fieldId, availableValues
record-typesRecord Types—/api/record-typesyesnodisplay name; required collectionId
record-versionsRecord Versions—/api/record-versionsyesyesrequired collectionId, recordId, versionNumber, changeType, changedBy, changeSource
report-foldersReport Folders—/api/report-foldersyesnodisplay name
reportsReports—/api/reportsyesnodisplay name; required reportType, primaryCollectionId, columns
saml-providersSAML Providers—/api/saml-providersyesnodisplay name; required registrationId, idpEntityId, ssoUrl
scheduled-jobsScheduled Jobs—/api/scheduled-jobsyesnodisplay name; required jobType, cronExpression
script-execution-logsScript Execution Logs—/api/script-execution-logsyesyesrequired scriptId, status
script-triggersScript Triggers—/api/script-triggersnonorequired scriptId, collectionId, triggerEvent
scriptsScripts—/api/scriptsyesnodisplay name; required scriptType, language, sourceCode
security-audit-logsSecurity Audit Logs—/api/security-audit-logsyesyesrequired eventType, eventCategory
seo-pagesSEO Pages—/api/seo-pagesyesyesdisplay title; required slug, published
setup-audit-entriesSetup Audit Entries—/api/setup-audit-entriesyesyesrequired userId, action, section, entityType
telehealth-appointmentsTelehealth Appointments—/api/telehealth-appointmentsyesnodisplay id; required status
telehealth-archivesTelehealth Archives—/api/telehealth-archivesyesnodisplay id; required sourceType, sourceId, legalHold
telehealth-availabilityTelehealth Availability—/api/telehealth-availabilityyesnodisplay id; required kind, timezone
tenantsTenants—/api/tenantsnonodisplay slug; required name, edition, status, ipAllowlistEnabled
ui-menu-itemsUI Menu Items—/api/ui-menu-itemsyesnodisplay label; required menuId, displayOrder, active
ui-menusUI Menus—/api/ui-menusyesnodisplay name; required isDefault, active
ui-pagesUI Pages—/api/ui-pagesyesnodisplay name; required path, active, published
ui-translationsUI Translations—/api/ui-translationsyesnodisplay key; required locale, value
user-groupsUser Groups—/api/user-groupsyesnodisplay name; required source
user-ui-preferencesUser UI Preferences—/api/user-ui-preferencesyesnodisplay prefKey; required userId, prefType, value
usersUsers—/api/usersyesnodisplay email; required userType, status
validation-rulesValidation Rules—/api/validation-rulesyesnodisplay name; required collectionId, errorConditionFormula, errorMessage, evaluateOn, severity
video-sessionsVideo Sessions—/api/video-sessionsyesnodisplay id; required roomName, status
watch-targetsWatch Targets—/api/watch-targetsyesnodisplay name; required source, externalId, active
watchesWatches—/api/watchesyesnodisplay id; required status
winsWins—/api/winsyesnodisplay summary; required isPublic

Edit this page on GitHub