GET groupmemberships Id

GET
/groupmemberships/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

Paste your JWT token here

Path Parameters

id*integer

The unique identifier of the group membership to retrieve.

Formatint32

Response Body

OK

application/json
  1. response

Represents the response DTO for a group membership, containing all relevant information about the group membership, including its properties and information about the associated member and group. The GroupMembershipResponseDTO is used to transfer comprehensive group membership data from the server to the client when retrieving group membership information, allowing for a complete representation of the group membership's details, member information, group information, and any associated role alias information in the response payload.

id*integer

The unique identifier of a group membership, assigned incrementally.

Formatint32
memberId?|

The member associated with this membership.

Formatuuid
memberName?|

The first name of the member.

groupId*integer

The group associated with this membership.

Formatint32
groupName*string

Represents a Group within the organization. A Group can be a Committee, Working Group, or Dispute group. Each Group has a unique identifier, a name, an active status, and can have multiple members associated with it through GroupMemberships. The Group entity also includes properties for the type of group and default financial information such as GL account and cost center. This entity is used to manage and organize different groups within the system, allowing for better collaboration and communication among members.

groupType*GroupType

Defines the type of a Group.

Formatint32
Value in"Committee""WorkingGroup""Dispute"
membershipYear*integer

The year of the membership.

Formatint32
roleAliasId?|

The role of the member in this group membership.

Formatint32
roleAliasName?|

The name of the role alias.

curl -X GET 'https://example.com/groupmemberships/0'
{  "id": 0,  "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",  "memberName": "string",  "groupId": 0,  "groupName": "string",  "groupType": "Committee",  "membershipYear": 0,  "roleAliasId": 0,  "roleAliasName": "string"}