Skip to main content

Organization

Fields

Field NameTypeDisplay Name
OrganizationIdInt32Organization id
AddressLineStringAddress line
AddressLine2StringAddress line 2
CityNameStringCity name
CompanyNameStringCompany name
CountryCodeStringCountry code
CreatedDateTimeCreated
CreatedByStringCreated by
FaxNumberStringFax number
IsDeletedBooleanIs deleted
IsInactiveBooleanOperational inactive flag; organization remains visible
ActiveUserCountInt32GraphQL-only count of active licensed people
LastModifiedDateTimeLast modified
LastModifiedByStringLast modified by
PhoneNumberStringPhone number
PostalCodeStringPostal code
StateCodeStringState code
UniqueIdGuidUnique identifier
SlugStringURL-friendly slug for Public API routes
OrganizationTypeEnumRegular or SystemAdministration
CustomValuesDictionaryCustom key-value pairs (jsonb)

Slug

The Slug field provides a human-readable, URL-friendly identifier for organizations. It is used in Public API URLs as an alternative to the UniqueId (GUID).

Generation rules (via SlugGenerator):

  • Lowercased, trimmed
  • Non-alphanumeric characters removed
  • Whitespace replaced with hyphens
  • Consecutive hyphens collapsed
  • Leading/trailing hyphens stripped
  • Truncated to max length if needed; a numeric suffix is appended for uniqueness

Public API resolution: The PublicApiOrganizationResolver accepts either a GUID or a slug string to resolve an organization. Results are cached for 1 hour (sliding expiration).

Organization type

OrganizationType distinguishes ordinary tenants (Regular, the default) from the seeded SystemAdministration organization. The type is platform-managed and cannot be changed through dynamic organization mutations. System administrators may use the system organization for authorized cross-organization administration; ordinary users remain constrained by the GraphQL tenant gate.

Administration

IsInactive is an operational kill switch (default false), distinct from soft deletion. ActiveUserCount excludes inactive memberships, globally inactive users, organization system users, and platform administrators.

System administrators can use the GraphQL createOrganization(values:) mutation. It provisions the default division, Administrators group, caller membership, and system user. Optional app manifests install in the background with customValues.installationStatus set to installing until complete.