Skip to content
MoltaroMoltaroMoltaro Docs

Lists type configuration in a readable community, including disabled types by default.

GET
/api/workspace/community-memberships/communities/{communityId}/membership-types
curl --request GET \
  --url 'https://example.com/api/workspace/community-memberships/communities/example/membership-types?enabledOnly=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
communityId
required
string

Selected community; inaccessible communities are concealed with NotFound.

Query Parameters

Section titled “Query Parameters”
enabledOnly
boolean

Whether to include only enabled types.

access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data
object
Data
Array<object>
nullable

HTTP type configuration for the operator catalog; contains no domain objects or Entity records.

object
Id

Stable type identity.

string
nullable
Community

A readable reference to another business object without loading its aggregate.

object
Id

Stable technical identity used for relationships and commands.

string
nullable
DisplayName

Current authorized display name; null when unavailable.

string
nullable
Key

The target’s symbolic key, when that object has one; independent of its display name.

string
nullable
DisplayName

Type name, unique in its community.

string
nullable
NumberPrefix

Prefix used for future issued numbers.

string
nullable
Kind
integer format: int32
Allowed values: 0 1 2
CorporatePaymentMode
integer format: int32
Allowed values: 0 1
Binding

HTTP values identifying the recipients and optional corporate relationship of a membership type.

object
PersonEntityDefinitionId

Person Data definition; required for Personal and Corporate.

string
nullable
OrganizationEntityDefinitionId

Organization Data definition; required for Organization and Corporate.

string
nullable
RelationshipKind
integer format: int32
Allowed values: 0 1
ReferenceOwnerKind
integer format: int32
Allowed values: 0 1
ReferenceFieldId

Stored Reference field or its inverse selection.

string
nullable
AssociationEntityDefinitionId

Governed Association definition; required only for Association.

string
nullable
PersonEndpointFieldId

Governed Association endpoint targeting the person definition.

string
nullable
OrganizationEndpointFieldId

Distinct governed Association endpoint targeting the organization definition.

string
nullable
IsEnabled

Availability for new memberships/groups.

boolean
IsBindingReadOnly

Always true: recipient definitions and relationship are fixed at creation.

boolean
RowVersion

Version read for the next command.

string format: uuid
Permissions

Community Memberships permissions the caller holds in the scope of a response: the Workspace for a list, one community for that community. The client offers an action only when its permission is granted; the server still checks every command.

object
Granted

Granted manifest permission keys, for example community.create, in manifest order.

Array<string>
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
  "Data": {
    "Data": [
      {
        "Kind": 0,
        "CorporatePaymentMode": 0,
        "Binding": {
          "RelationshipKind": 0,
          "ReferenceOwnerKind": 0
        }
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}