Terminology

Keep the same routes and field names

Custom terminology does not rename API paths, JSON field names or API scope keys. For example, changing the member label does not rename /api/v1/members, memberId or the members scope. Member names and identifiers remain resource data.

Read and update label values

The terminology endpoints store noun labels as singular and plural strings, plus action and icon settings. These values do change when terminology is customised. For example, this is a partial update body for PATCH /api/v1/terminology:

{
  "member": {
    "singular": "headmate",
    "plural": "headmates"
  }
}

The settings response keeps the fixed terms.member.singular and terms.member.plural field paths. The scoped terminology endpoint resolves settings using the selected system scope.

Use terminology: read to read settings or terminology: read_write to update them. See the terminology reference for global and scoped routes.