Skip to main content

Schema Reference

This page documents the fields, types, and relationships for the most commonly used ZeyOS resources. Use it as a quick lookup when building queries, creating records, or planning data integrations.

Conventions

  • Timestamps are Unix timestamps in seconds (not milliseconds). Convert with new Date(value * 1000) in JavaScript.
  • Visibility controls soft-delete behaviour: 0 = regular, 1 = archived, 2 = deleted. Always include visibility: 0 in filters to exclude archived and deleted records.
  • GIN-indexed fields support the filters (plural) parameter. Using filter (singular) with these fields silently returns unfiltered results. See the Practical Guide for details.
  • Fields marked (required) are NOT NULL in the database. Most of them have a server-side default (for example creator defaults to the authenticated user, creationdate/lastmodified default to the current time, integer flags default to 0), so a create that omits them still succeeds. The exception to watch is currency on accounts: it is NOT NULL with no default, so createAccount without it fails with an opaque HTTP 500. On updates (PATCH), only the fields you send are changed.
  • Foreign key fields (e.g. account, project, ticket) accept integer IDs referencing the related resource.

Accounts

FieldTypeDescription
IDintegerAccount ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
contactintegerContact ID
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
lastnametextLast name (surname or company name); required if firstname is empty (required)
firstnametextFirst name (given name); required if lastname is empty (required)
typeintegerAccount type (0=PROSPECT, 1=CUSTOMER, 2=SUPPLIER, 3=CUSTOMERANDSUPPLIER, 4=COMPETITOR, 5=EMPLOYEE) (required)
customernumtextCustomer number; only for PROSPECT, CUSTOMER, CUSTOMERANDSUPPLIER, or EMPLOYEE (required)
suppliernumtextSupplier number; only for SUPPLIER or CUSTOMERANDSUPPLIER (required)
taxidtextTax ID (e.g. VATIN or SSN) (required)
currencyvarcharCurrency code (ISO 4217) (required)
lockedintegerDeny booking of billing or procurement transactions (required)
excludetaxintegerExclude from taxation (required)
descriptiontextDetailed general description (required)

GIN-indexed fields (use filters plural): assigneduser, customernum, firstname, lastname, suppliernum


Contacts

FieldTypeDescription
IDintegerContact ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
davserverintegerDAV server ID
picbinfileintegerBinary file ID; read-only (not for PUT or PATCH)
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
lastnametextLast name (surname or company name); required if firstname is empty (required)
firstnametextFirst name (given name); required if lastname is empty (required)
typeintegerContact type (0=COMPANY, 1=PERSON) (required)
titletextTitle or salutation; only for PERSON (required)
companytextCompany name; only for PERSON (required)
positiontextPosition or job title; only for PERSON (required)
departmenttextDepartment; only for PERSON (required)
addresstextAddress (street and building/suite number) (required)
postalcodetextPostal or ZIP code (required)
citytextCity or locality (required)
regiontextRegion or state (required)
countryvarcharCountry code (ISO 3166-1 alpha-2) (required)
phonetextPrimary phone number (required)
phone2textSecondary phone number (required)
celltextCell phone number (required)
faxtextFax number (required)
emailtextPrimary e-mail address (required)
email2textSecondary e-mail address (required)
websitetextWebsite URL (required)
birthdatetimestampBirth date as Unix timestamp; only for PERSON
descriptiontextDetailed general description (required)

GIN-indexed fields (use filters plural): assigneduser, davserver, company, email, email2, firstname, lastname


Tickets

FieldTypeDescription
IDintegerTicket ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
accountintegerAccount ID; mutually exclusive with project
projectintegerProject ID; mutually exclusive with account
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
nametextName (required)
ticketnumtextTicket number (required)
datetimestampDesignated date as Unix timestamp (defaults to now on creation) (required)
duedatetimestampDue date as Unix timestamp
statusintegerStatus (0=NOTSTARTED, 1=AWAITINGACCEPTANCE, 2=ACCEPTED, 3=REJECTED, 4=ACTIVE, 5=INACTIVE, 6=FEEDBACKREQUIRED, 7=TESTING, 8=CANCELLED, 9=COMPLETED, 10=FAILED, 11=BOOKED) (required)
priorityintegerPriority (0=LOWEST, 1=LOW, 2=MEDIUM, 3=HIGH, 4=HIGHEST) (required)
descriptiontextDetailed general description (required)
billingitemsjsonJSON-encoded billing items (array)
procurementitemsjsonJSON-encoded procurement items (array)

GIN-indexed fields (use filters plural): assigneduser, project, name, ticketnum


Tasks

FieldTypeDescription
IDintegerTask ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
davserverintegerDAV server ID
ticketintegerTicket ID; mutually exclusive with project
projectintegerProject ID; mutually exclusive with ticket
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
nametextName (required)
tasknumtextTask number (required)
datefromtimestampStart date as Unix timestamp
duedatetimestampDue date as Unix timestamp
statusintegerStatus (0=NOTSTARTED, 1=AWAITINGACCEPTANCE, 2=ACCEPTED, 3=REJECTED, 4=ACTIVE, 5=INACTIVE, 6=FEEDBACKREQUIRED, 7=TESTING, 8=CANCELLED, 9=COMPLETED, 10=FAILED, 11=BOOKED) (required)
priorityintegerPriority (0=LOWEST, 1=LOW, 2=MEDIUM, 3=HIGH, 4=HIGHEST) (required)
projectedeffortintegerProjected effort in minutes (required)
descriptiontextDetailed general description (required)

GIN-indexed fields (use filters plural): assigneduser, davserver, project, name, tasknum


Projects

FieldTypeDescription
IDintegerProject ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
accountintegerAccount ID
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
nametextName (required)
projectnumtextProject number (required)
statusintegerStatus (0=DRAFT, 1=NOTSTARTED, 2=AWAITINGAPPROVAL, 3=APPROVED, 4=DISMISSED, 5=ACTIVE, 6=INACTIVE, 7=TESTING, 8=CANCELLED, 9=COMPLETED, 10=FAILED, 11=BOOKED) (required)
descriptiontextDetailed general description (required)

GIN-indexed fields (use filters plural): assigneduser, name, projectnum


Appointments

FieldTypeDescription
IDintegerAppointment ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
davserverintegerDAV server ID
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
nametextName (required)
locationtextLocation (required)
colorvarcharColor code (CSS hex without #) (required)
datefromtimestampStart date as Unix timestamp; must be <= dateto (required)
datetotimestampEnd date as Unix timestamp; must be >= datefrom (required)
recurrenceintegerRecurrence (0=DAY, 1=WORKDAY, 2=WEEK, 3=MONTH, 4=YEAR)
intervalintegerRecurrence interval in minutes (required)
maxoccurrencesintegerMaximum occurrences including start date (0=unlimited) (required)
daterecurrencetimestampRecurrence end date as Unix timestamp
descriptiontextDetailed general description (required)

GIN-indexed fields (use filters plural): assigneduser, davserver, location, name


Transactions

FieldTypeDescription
IDintegerTransaction ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
accountintegerAccount ID
itemintegerItem ID; must be null for BILLING and PROCUREMENT
contractintegerContract ID
transactionnumtextTransaction number (required)
typeintegerTransaction type (0=BILLING_QUOTE, 1=BILLING_ORDER, 2=BILLING_DELIVERY, 3=BILLING_INVOICE, 4=BILLING_CREDIT, 5=PROCUREMENT_REQUEST, 6=PROCUREMENT_ORDER, 7=PROCUREMENT_DELIVERY, 8=PROCUREMENT_INVOICE, 9=PROCUREMENT_CREDIT, 10=PRODUCTION_FABRICATION, 11=PRODUCTION_DISASSEMBLY) (required)
datetimestampDesignated date as Unix timestamp (defaults to now on creation) (required)
duedatetimestampDue date as Unix timestamp
statusintegerStatus (0=DRAFT, 1=BOOKED, 2=HOLD, 3=CANCELLED, 4=CLOSED, ... 20=PAID, 21=OVERPAID, 22=PROCESSED, 23=PROCESSED_CANCELLED) (required)
calculationintegerCalculation method (0=NET, 1=GROSS, 2=EXACT, 3=LEGACY, 4=EXTERNAL) (required)
productionfactorintegerProduction factor; required for PRODUCTION, otherwise null
currencyvarcharCurrency code (ISO 4217) (required)
exchangeratefloatExchange rate as multiple of system currency unit (required)
taxidtextBuyer Tax ID (e.g. VATIN or SSN) (required)
shippingrecipienttextShipping recipient (required)
shippingaddresstextShipping address (required)
shippingpostalcodetextShipping postal code (required)
shippingcitytextShipping city (required)
shippingregiontextShipping region or state (required)
shippingcountryvarcharShipping country code (ISO 3166-1 alpha-2) (required)
billingrecipienttextBilling recipient (required)
billingaddresstextBilling address (required)
billingpostalcodetextBilling postal code (required)
billingcitytextBilling city (required)
billingregiontextBilling region or state (required)
billingcountryvarcharBilling country code (ISO 3166-1 alpha-2) (required)
sellertaxidtextSeller Tax ID (required)
sellernametextSeller name (required)
selleraddresstextSeller address (required)
sellerpostalcodetextSeller postal code (required)
sellercitytextSeller city (required)
sellerregiontextSeller region or state (required)
sellercountryvarcharSeller country code (ISO 3166-1 alpha-2) (required)
discountfloatTotal absolute discount (required)
netamountfloatTotal net amount (required)
taxfloatTotal tax amount (required)
marginfloatTotal absolute margin (required)
weightfloatTotal shipping weight in kg (required)
itemsjsonJSON-encoded line items (array)

GIN-indexed fields (use filters plural): assigneduser, transactionnum


Items

FieldTypeDescription
IDintegerItem ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
modelintegerModel item ID; only for non-MODEL items
picbinfileintegerBinary file ID; read-only (not for PUT or PATCH)
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
nametextProduct name (required)
manufacturertextManufacturer (brand or company) (required)
itemnumtextItem number / SKU (required)
barcodetextBarcode (e.g. GTIN, EAN, UPC) (required)
typeintegerItem type (0=SIMPLE, 1=SERIALS, 2=CHARGES, 3=SERIALSANDCHARGES, 4=SET, 5=CONTAINER, 6=NOSTOCK, 7=MODEL) (required)
forcestockintegerForce stock check on depletion (0=STORAGE, 1=LOCATION)
applicabilityintegerApplicability (0=ALWAYS, 1=NEVER, 2=BILLINGONLY, 3=PROCUREMENTONLY) (required)
unitvarcharUnit code (UN/CEFACT Recommendation 20) (required)
sellingpricefloatDefault selling price per unit (required)
purchasepricefloatDefault purchase price per unit (required)
taxratefloatTax rate in percent
weightfloatShipping weight per unit in kg (required)
classcodetextProduct classification code (e.g. GPC, UNSPSC) (required)
tariffcodetextTariff code (e.g. HS, CN, HTS) (required)
originvarcharOrigin country code (ISO 3166-1 alpha-2) (required)
descriptiontextDetailed general description (required)
foreigntaxratesjsonCountry-specific tax rates; use country code as key

GIN-indexed fields (use filters plural): barcode, itemnum, manufacturer, name


Opportunities

FieldTypeDescription
IDintegerOpportunity ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
accountintegerAccount ID
contactintegerContact ID
campaignintegerCampaign ID
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
nametextName (required)
opportunitynumtextOpportunity number (required)
datetimestampDesignated date as Unix timestamp (defaults to now on creation) (required)
duedatetimestampDue date as Unix timestamp
statusintegerStatus (0=UNEVALUATED, 1=ELIGIBLE, 2=FEEDBACKREQUIRED, 3=INNEGOTIATION, 4=OFFERED, 5=ACCEPTED, 6=REJECTED) (required)
priorityintegerPriority (0=LOWEST, 1=LOW, 2=MEDIUM, 3=HIGH, 4=HIGHEST) (required)
probabilityintegerProbability of success in percent; must be 100 for ACCEPTED (required)
worstcasefloatWorst-case monetary outcome (required)
mostlikelyfloatMost likely monetary outcome (required)
upsidefloatUpside monetary outcome (required)
descriptiontextDetailed general description (required)

GIN-indexed fields (use filters plural): assigneduser, name, opportunitynum


Documents

FieldTypeDescription
IDintegerDocument ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
binfileintegerBinary file ID; read-only (not for PUT or PATCH)
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
nametextName (required)
documentnumtextDocument number (required)
statusintegerStatus (0=DRAFT, 1=FEEDBACKREQUIRED, 2=INREVISION, 3=AWAITINGAPPROVAL, 4=FINAL, 5=OBSOLETE) (required)
filenametextFilename (required)
mimetypetextMIME type (required)
publicintegerPublicly accessible (required)
descriptiontextDetailed general description (required)

GIN-indexed fields (use filters plural): assigneduser, documentnum, filename, name


Notes

FieldTypeDescription
IDintegerNote ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
binfileintegerBinary file ID; read-only (not for PUT or PATCH)
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
nametextName (required)
statusintegerStatus (0=DRAFT, 1=FEEDBACKREQUIRED, 2=INREVISION, 3=AWAITINGAPPROVAL, 4=FINAL, 5=OBSOLETE) (required)
contenttypetextContent MIME type (required)
texttextPlain text content (required)
attachmentstext[]Array of attachment filenames
descriptiontextDetailed general description (required)

GIN-indexed fields (use filters plural): assigneduser, name


Messages

FieldTypeDescription
IDintegerMessage ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
mailserverintegerMail server ID
ticketintegerTicket ID; mutually exclusive with opportunity
opportunityintegerOpportunity ID; mutually exclusive with ticket
mailinglistintegerMailing list ID
referenceintegerReference message (reply-to) ID; must be distinct from ID
binfileintegerBinary file ID; read-only (not for PUT or PATCH)
mailboxintegerMailbox type (0=INBOX, 1=DRAFTS, 2=SENT, 3=TEMPLATES, 4=MAILINGS, 5=ARCHIVE, 6=TRASH, 7=JUNK) (required)
verifiedintegerVerified sender e-mail address (required)
datetimestampDesignated date as Unix timestamp (defaults to now on creation) (required)
subjecttextSubject (required)
sendertextSender name and e-mail address (required)
sender_emailtextSender e-mail address (required)
sender_nametextSender name (required)
totextAll regular recipient names and e-mail addresses (required)
to_emailtextFirst regular recipient e-mail address (required)
to_nametextFirst regular recipient name (required)
to_countintegerNumber of regular recipients (required)
cctextCarbon copy recipients (required)
bcctextBlind carbon copy recipients (required)
contenttypetextContent MIME type (required)
texttextPlain text content (required)
attachmentstext[]Array of attachment filenames
senddatetimestampScheduled send date as Unix timestamp
senderrortextLast send error message (required)
messageidtextMessage-ID header (required)

GIN-indexed fields (use filters plural): mailinglist, mailserver, sender, subject, to


Comments

FieldTypeDescription
IDtimestampComment ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
recordtimestampRecord ID (parent record dependency) (required)
datetimestampDesignated date as Unix timestamp (defaults to now on creation) (required)
sendertextSender (required)
texttextComment text (Markdown for rich text) (required)
metajsonJSON-encoded metadata (object)

Events

FieldTypeDescription
IDintegerEvent ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
entityt_entityCanonical entity (required)
indexintegerEntity ID (required)
nametextName (required)
colorvarcharColor code (CSS hex without #) (required)
datefromtimestampStart date as Unix timestamp; must be <= dateto (required)
datetotimestampEnd date as Unix timestamp; must be >= datefrom (required)
metajsonJSON-encoded metadata (object)

Campaigns

FieldTypeDescription
IDintegerCampaign ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
nametextName (required)
datefromtimestampStart date as Unix timestamp; must be <= dateto (required)
datetotimestampEnd date as Unix timestamp; must be >= datefrom
statusintegerStatus (0=DRAFT, 1=NOTSTARTED, 2=AWAITINGAPPROVAL, 3=APPROVED, 4=DISMISSED, 5=ACTIVE, 6=INACTIVE, 7=INEVALUATION, 8=CANCELLED, 9=CLOSED) (required)
descriptiontextDetailed general description (required)

GIN-indexed fields (use filters plural): assigneduser, name


Contracts

FieldTypeDescription
IDintegerContract ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
accountintegerAccount ID
visibilityintegerVisibility (0=REGULAR, 1=ARCHIVED, 2=DELETED) (required)
nametextName (required)
contractnumtextContract number (required)
datetimestampDesignated date as Unix timestamp (defaults to now on creation) (required)
datefromtimestampStart date as Unix timestamp; must be <= dateto
datetotimestampEnd date as Unix timestamp; must be >= datefrom
datecanceltimestampCancellation date as Unix timestamp
statusintegerStatus (0=DRAFT, 1=AWAITINGAPPROVAL, 2=APPROVED, 3=DISMISSED, 4=ACTIVE, 5=INACTIVE, 6=EXPIRED, 7=CANCELLED, 8=CLOSED) (required)
currencyvarcharCurrency code (ISO 4217) (required)
exchangeratefloatExchange rate as multiple of system currency unit (required)
billingcycleintegerBilling cycle in months
lastbillingtimestampLast billing date as Unix timestamp
descriptiontextDetailed general description (required)
contractitemsjsonJSON-encoded contract items (array)
billingitemsjsonJSON-encoded billing items (array)
procurementitemsjsonJSON-encoded procurement items (array)
autobillingjsonJSON-encoded auto-billing data; only if billingcycle is set

GIN-indexed fields (use filters plural): assigneduser, status, contractnum, name


Files

FieldTypeDescription
IDtimestampFile ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
recordtimestampRecord ID (parent dependency); mutually exclusive with comment
commenttimestampComment ID (parent dependency); mutually exclusive with record
binfileintegerBinary file ID; read-only (not for PUT or PATCH)
filenametextFilename (required)
mimetypetextMIME type (required)

GIN-indexed fields (use filters plural): filename


Payments

FieldTypeDescription
IDintegerPayment ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
assigneduserintegerAssigned user ID
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
ledgerintegerLedger ID
transactionintegerTransaction ID; mutually exclusive with account
accountintegerAccount ID; mutually exclusive with transaction
datetimestampDesignated date as Unix timestamp (defaults to now on creation) (required)
subjecttextSubject (e.g. bank statement or reference number) (required)
statusintegerStatus (0=DRAFT, 1=COMPLETED, 2=CANCELLED, 3=BOOKED) (required)
amountfloatAmount (monetary) (required)
autoadvanceintegerAuto-advance to next transaction (required)
descriptiontextDetailed general description (required)

GIN-indexed fields (use filters plural): assigneduser, ledger, subject


Users

FieldTypeDescription
IDintegerUser ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
contactintegerContact ID
activityintegerActivity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED) (required)
nametextUsername (case-insensitively unique) (required)
emailtextSystem e-mail address (case-insensitively unique) (required)
nopublicintegerDeny access to public data (required)
apionlyintegerRestricted to API access, no regular login (required)
expdatetimestampExpiry date as Unix timestamp
descriptiontextDescription (required)

GIN-indexed fields (use filters plural): email, name


Groups

FieldTypeDescription
IDintegerGroup ID (required)
creatorintegerCreator user ID (defaults to authenticated user on creation)
creationdatetimestampCreation date as Unix timestamp (defaults to now on creation) (required)
lastmodifiedtimestampLast modification date as Unix timestamp (auto-reset on modification) (required)
leaderintegerLeader user ID
activityintegerActivity (0=ACTIVE, 1=DEACTIVATED, 2=DELETED) (required)
nametextName (case-insensitively unique) (required)
descriptiontextDescription (required)

GIN-indexed fields (use filters plural): name