Organizations

Download schema

Organization entity CRUD and metadata endpoints

Get organization UI metadata

GET

http://localhost:3001

/api/v1/entities/organization/meta

Bearer (JWT)

X-API-Key (header)

Get organization UI metadata › Responses

200

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

GET/api/v1/entities/organization/meta

fetch('http://localhost:3001/api/v1/entities/organization/meta', {
  headers: {
    Authorization: 'Bearer <token>'
  }
})

Example Responses

{
  "entity": "entity",
  "translation_key": "translation_key",
  "title_key": "title_key",
  "uid": "uid",
  "display_field": "display_field",
  "display_name": "display_name",
  "actions_overrides": {
    "key": {
      "enabled": true
    }
  },
  "columns": [
    {
      "key": "key",
      "label_key": "label_key",
      "type": "text",
      "order": 0,
      "sticky": true,
      "audited": true,
      "sortable": true,
      "searchable": true,
      "hideable": true,
      "default_visible": true,
      "filterable": true,
      "badge": {
        "values": {
          "key": {
            "label_key": "label_key",
            "label_text": "label_text",
            "color": "color"
          }
        }
      },
      "datetime_iana_toggle": {
        "record_iana_field": "record_iana_field"
      },
      "tooltip": "tooltip",
      "tooltip_priority": "INFORMATION",
      "tooltip_title": "tooltip_title",
      "show_form_tooltip": true,
      "show_list_tooltip": true
    }
  ],
  "table": {
    "default_view": "table",
    "default_sort": {
      "key": "key",
      "dir": "asc"
    },
    "default_page_size": 0,
    "page_size_options": [
      0
    ],
    "row_custom_actions": [
      {
        "action_name": "action_name",
        "translation_key": "translation_key",
        "icon": "icon",
        "text_color": "text_color",
        "disabled_when_deleted": true,
        "required_permission": "required_permission"
      }
    ]
  },
  "actions": [
    {
      "op": "op",
      "enabled": true,
      "permissions": [
        "string"
      ],
      "sentinel": "_public",
      "endpoint": {
        "method": "method",
        "path": "path"
      }
    }
  ],
  "collaboration": {
    "enabled": true,
    "expose_editing_value": true
  }
}

json

application/json

List organizations

GET

http://localhost:3001

/api/v1/entities/organization/list

Bearer (JWT)

X-API-Key (header)

List organizations › query Parameters

search

string

search_in

string

CSV of fields to search in (e.g. idp_code,uuid,display_name)

sort_key

string · enum

Enum values:

updated_at

uuid

idp_code

display_name

sort_dir

string · enum

Enum values:

asc

desc

page

integer · min: 1

page_size

integer · min: 1 · max: 100

object[]

Advanced filter conditions array

List organizations › Responses

200

EntityListResponseOrganization

OrganizationDetail[] · required

page

integer · required

page_size

integer · required

total

integer · required

GET/api/v1/entities/organization/list

fetch('http://localhost:3001/api/v1/entities/organization/list', {
  headers: {
    Authorization: 'Bearer <token>'
  }
})

Example Responses

{
  "rows": [
    {
      "uuid": "00000000-0000-0000-0000-000000000000",
      "idp_code": "idp_code",
      "display_name": "display_name",
      "website_url": "https://www.example.com/path/to/resource",
      "user_count": 0,
      "created_at": "2026-04-16T12:01:44.606Z",
      "created_by": "created_by",
      "created_by_name": "created_by_name",
      "updated_at": "2026-04-16T12:01:44.606Z",
      "updated_by": "updated_by",
      "updated_by_name": "updated_by_name",
      "last_synced_at": "2026-04-16T12:01:44.606Z",
      "version": 0,
      "deleted_at": "2026-04-16T12:01:44.606Z",
      "deleted_by": "deleted_by"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0
}

json

application/json

Create organization

POST

http://localhost:3001

/api/v1/entities/organization

Bearer (JWT)

X-API-Key (header)

Create organization › Request Body

OrganizationCreateBody

idp_code

string · maxLength: 255 · required

display_name

string · maxLength: 255

website_url

string · uri · maxLength: 2048

Create organization › Responses

Created

OrganizationCreateResponse

OrganizationDetail · required

success

boolean

POST/api/v1/entities/organization

fetch('http://localhost:3001/api/v1/entities/organization', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: 'Bearer <token>'
  },
  body: JSON.stringify({
    idp_code: 'idp_code',
    display_name: 'display_name',
    website_url: 'https://www.example.com/path/to/resource'
  })
})

Example Request Body

{
  "idp_code": "idp_code",
  "display_name": "display_name",
  "website_url": "https://www.example.com/path/to/resource"
}

json

Example Responses

{
  "success": true,
  "organization": {
    "uuid": "00000000-0000-0000-0000-000000000000",
    "idp_code": "idp_code",
    "display_name": "display_name",
    "website_url": "https://www.example.com/path/to/resource",
    "user_count": 0,
    "created_at": "2026-04-16T12:01:44.606Z",
    "created_by": "created_by",
    "created_by_name": "created_by_name",
    "updated_at": "2026-04-16T12:01:44.606Z",
    "updated_by": "updated_by",
    "updated_by_name": "updated_by_name",
    "last_synced_at": "2026-04-16T12:01:44.606Z",
    "version": 0,
    "deleted_at": "2026-04-16T12:01:44.606Z",
    "deleted_by": "deleted_by"
  }
}

json

application/json

Get organization detail

GET

http://localhost:3001

/api/v1/entities/organization/{uuid}

Bearer (JWT)

X-API-Key (header)

Get organization detail › path Parameters

uuid

string · uuid · required

Get organization detail › Responses

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

GET/api/v1/entities/organization/{uuid}

fetch('http://localhost:3001/api/v1/entities/organization/:uuid', {
  headers: {
    Authorization: 'Bearer <token>'
  }
})

Example Responses

{
  "uuid": "00000000-0000-0000-0000-000000000000",
  "idp_code": "idp_code",
  "display_name": "display_name",
  "website_url": "https://www.example.com/path/to/resource",
  "user_count": 0,
  "created_at": "2026-04-16T12:01:44.606Z",
  "created_by": "created_by",
  "created_by_name": "created_by_name",
  "updated_at": "2026-04-16T12:01:44.606Z",
  "updated_by": "updated_by",
  "updated_by_name": "updated_by_name",
  "last_synced_at": "2026-04-16T12:01:44.606Z",
  "version": 0,
  "deleted_at": "2026-04-16T12:01:44.606Z",
  "deleted_by": "deleted_by"
}

json

application/json

Customers Authentication

Get organization UI metadata

GET

http://localhost:3001

/api/v1/entities/organization/meta

Bearer (JWT)

X-API-Key (header)

Get organization UI metadata › Responses

200

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

List organizations

GET

http://localhost:3001

/api/v1/entities/organization/list

Bearer (JWT)

X-API-Key (header)

List organizations › query Parameters

search

string

search_in

string

CSV of fields to search in (e.g. idp_code,uuid,display_name)

sort_key

string · enum

Enum values:

updated_at

uuid

idp_code

display_name

sort_dir

string · enum

Enum values:

asc

desc

page

integer · min: 1

page_size

integer · min: 1 · max: 100

object[]

Advanced filter conditions array

List organizations › Responses

200

EntityListResponseOrganization

OrganizationDetail[] · required

page

integer · required

page_size

integer · required

total

integer · required

Create organization

POST

http://localhost:3001

/api/v1/entities/organization

Bearer (JWT)

X-API-Key (header)

Create organization › Request Body

OrganizationCreateBody

idp_code

string · maxLength: 255 · required

display_name

string · maxLength: 255

website_url

string · uri · maxLength: 2048

Create organization › Responses

Created

OrganizationCreateResponse

OrganizationDetail · required

success

boolean

Get organization detail

GET

http://localhost:3001

/api/v1/entities/organization/{uuid}

Bearer (JWT)

X-API-Key (header)

Get organization detail › path Parameters

uuid

string · uuid · required

Get organization detail › Responses

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