Schemas

Download schema

CustomerStatus

string · enum

Enum values:

ACTIVE

INACTIVE

CustomerCreateBody

code

string · maxLength: 20 · required

first_name

string

last_name

string

company_name

string

email

string · email · maxLength: 320

phone

string · maxLength: 64

status

CustomerStatus · enum

Enum values:

ACTIVE

INACTIVE

status_reason

string

local_address

string

local_city

string

local_state

string

local_country

string

local_zip

string

onboarding_at

string · date-time

Onboarding instant (UTC in DB). Send ISO-8601; pair with onboarding_time_zone for display in that IANA zone.

onboarding_time_zone

string · maxLength: 100

IANA time zone id (e.g. Europe/Rome). Required if onboarding_at is set.

Example: Europe/Rome

CustomerCreateResponse

uuid

string · uuid · required

CustomerDetail

uuid

string · uuid · required

code

string · maxLength: 20 · required

status

CustomerStatus · enum · required

Enum values:

ACTIVE

INACTIVE

created_at

string · date-time · required

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

created_by

string · required

updated_at

string · date-time · required

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

updated_by

string · required

version

integer · required

first_name

string

last_name

string

company_name

string

email

string · email · maxLength: 320

phone

string · maxLength: 64

status_reason

string

local_address

string

local_city

string

local_state

string

local_country

string

local_zip

string

onboarding_at

string · date-time

Onboarding instant (stored as UTC / timestamptz). Use onboarding_time_zone with Intl in the UI for local wall time (incl. DST).

Example: 2026-04-16T12:01:44.606Z

onboarding_time_zone

string · maxLength: 100

IANA zone captured when onboarding was recorded.

Example: Europe/Rome

deleted_at

string · date-time

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

deleted_by

string

CustomerListItem

uuid

string · required

code

string · required

status

CustomerStatus · enum · required

Enum values:

ACTIVE

INACTIVE

updated_at

string · date-time · required

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

version

integer · required

first_name

string

last_name

string

company_name

string

email

string · email

phone

string

EntityListResponseCustomer

CustomerDetail[] · required

page

integer · required

page_size

integer · required

total

integer · required

OrganizationCreateBody

idp_code

string · maxLength: 255 · required

display_name

string · maxLength: 255

website_url

string · uri · maxLength: 2048

OrganizationCreateResponse

OrganizationDetail · required

success

boolean

OrganizationDetail

uuid

string · uuid · required

idp_code

string · maxLength: 255 · required

created_at

string · date-time · required

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

updated_at

string · date-time · required

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

version

integer · required

display_name

string · maxLength: 255

website_url

string · uri · maxLength: 2048

user_count

integer

created_by

string

created_by_name

string

updated_by

string

updated_by_name

string

last_synced_at

string · date-time

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

deleted_at

string · date-time

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

deleted_by

string

EntityListResponseOrganization

OrganizationDetail[] · required

page

integer · required

page_size

integer · required

total

integer · required

LoginBody

username

string · required

password

string · required

LoginResponse

User · required

success

boolean

User

username

string · required

display_name

string · required

email

string · email · required

expires_at

integer · required

Expiration timestamp in milliseconds

Role[] · required

organization

string

Role

name

string · required

display_name

string · required

owner

string · required

UserProfile

uuid

string · uuid · required

idp_code

string · required

email

string · email · required

display_name

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

version

integer · required

idp_org

string

idp_username

string

avatar_color

string · pattern: ^#[0-9A-Fa-f]{6}$

avatar_initials

string

is_active

boolean

is_admin

boolean

roles

string[]

created_by

string

created_by_name

string

updated_by

string

updated_by_name

string

deleted_at

string · date-time

deleted_by

string

deleted_by_name

string

UserProfileUpdateBody

display_name

string

email

string · email

avatar_color

string · pattern: ^#[0-9A-Fa-f]{6}$

avatar_initials

string

EntityMetaResponse

entity

string · required

Entity key, snake_case singular

translation_key

string · required

snake_case singular i18n prefix

uid

string · required

Column key used as row identity (e.g. uuid)

display_field

string · required

Key of the primary display column

display_name

string · required

Display template (${field} syntax). Defaults to "${display_field}" — materialized by assembleMeta

object[] · required

Root-level field dictionary, transversal to all page types

object[] · required

Derived capability contract — full standard op vocabulary, enabled:false when the route is absent or product-disabled

title_key

string

Optional i18n key overriding the canonical page title (absent → built from system.entities.page_title.* templates)

object

Per-op enabled toggles — may only affect existing ops, never invent them

object

EntityListTable options — absent on form-only metas (e.g. /auth/me/meta)

object

Injected by assembleMeta from entity auditability

CustomerCreateBody

code

string · maxLength: 20 · required

first_name

string

last_name

string

company_name

string

email

string · email · maxLength: 320

phone

string · maxLength: 64

status

CustomerStatus · enum

Enum values:

ACTIVE

INACTIVE

status_reason

string

local_address

string

local_city

string

local_state

string

local_country

string

local_zip

string

onboarding_at

string · date-time

Onboarding instant (UTC in DB). Send ISO-8601; pair with onboarding_time_zone for display in that IANA zone.

onboarding_time_zone

string · maxLength: 100

IANA time zone id (e.g. Europe/Rome). Required if onboarding_at is set.

Example: Europe/Rome

CustomerDetail

uuid

string · uuid · required

code

string · maxLength: 20 · required

status

CustomerStatus · enum · required

Enum values:

ACTIVE

INACTIVE

created_at

string · date-time · required

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

created_by

string · required

updated_at

string · date-time · required

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

updated_by

string · required

version

integer · required

first_name

string

last_name

string

company_name

string

email

string · email · maxLength: 320

phone

string · maxLength: 64

status_reason

string

local_address

string

local_city

string

local_state

string

local_country

string

local_zip

string

onboarding_at

string · date-time

Onboarding instant (stored as UTC / timestamptz). Use onboarding_time_zone with Intl in the UI for local wall time (incl. DST).

Example: 2026-04-16T12:01:44.606Z

onboarding_time_zone

string · maxLength: 100

IANA zone captured when onboarding was recorded.

Example: Europe/Rome

deleted_at

string · date-time

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

deleted_by

string

CustomerListItem

uuid

string · required

code

string · required

status

CustomerStatus · enum · required

Enum values:

ACTIVE

INACTIVE

updated_at

string · date-time · required

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

version

integer · required

first_name

string

last_name

string

company_name

string

email

string · email

phone

string

OrganizationDetail

uuid

string · uuid · required

idp_code

string · maxLength: 255 · required

created_at

string · date-time · required

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

updated_at

string · date-time · required

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

version

integer · required

display_name

string · maxLength: 255

website_url

string · uri · maxLength: 2048

user_count

integer

created_by

string

created_by_name

string

updated_by

string

updated_by_name

string

last_synced_at

string · date-time

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

deleted_at

string · date-time

DateTime (instant). Serialized as RFC3339 / ISO-8601 string with timezone (Z or +/-HH:MM).

Example: 2026-04-16T12:01:44.606Z

deleted_by

string

UserProfile

uuid

string · uuid · required

idp_code

string · required

email

string · email · required

display_name

string · required

created_at

string · date-time · required

updated_at

string · date-time · required

version

integer · required

idp_org

string

idp_username

string

avatar_color

string · pattern: ^#[0-9A-Fa-f]{6}$

avatar_initials

string

is_active

boolean

is_admin

boolean

roles

string[]

created_by

string

created_by_name

string

updated_by

string

updated_by_name

string

deleted_at

string · date-time

deleted_by

string

deleted_by_name

string

EntityMetaResponse

entity

string · required

Entity key, snake_case singular

translation_key

string · required

snake_case singular i18n prefix

uid

string · required

Column key used as row identity (e.g. uuid)

display_field

string · required

Key of the primary display column

display_name

string · required

Display template (${field} syntax). Defaults to "${display_field}" — materialized by assembleMeta

object[] · required

Root-level field dictionary, transversal to all page types

object[] · required

Derived capability contract — full standard op vocabulary, enabled:false when the route is absent or product-disabled

title_key

string

Optional i18n key overriding the canonical page title (absent → built from system.entities.page_title.* templates)

object

Per-op enabled toggles — may only affect existing ops, never invent them

object

EntityListTable options — absent on form-only metas (e.g. /auth/me/meta)

object

Injected by assembleMeta from entity auditability