GET members
BearerAuthorizationBearer <token>Paste your JWT token here
Search?stringThe search term used to filter members based on their first name, last name, or email. This field allows for searching and retrieving members that match the specified search criteria, enabling users to quickly find members based on their name or email information in the system. The Search property is essential for providing a convenient and efficient way to filter member data based on relevant keywords, enhancing the user experience when retrieving member information in the client application based on their name or email details in the system.
PageSize?integerThe size of the page to be retrieved when paginating member data. This field is used to specify the number of member records to be included in each page of the response when retrieving member information in a paginated format. The PageSize property is essential for controlling the amount of member data returned in each page, allowing for efficient retrieval and display of member information in the client application based on pagination criteria in the system.
int32Page?integerThe page number to be retrieved when paginating member data. This field is used to specify the page of member records to be included in the response when retrieving member information in a paginated format. The Page property is essential for controlling the specific page of member data returned in the response, allowing for efficient retrieval and display of member information in the client application based on pagination criteria in the system.
int32StudyId?integerThe unique identifier of the study for which to filter members based on their study enrollments. This field is optional, and if provided, it allows for filtering members based on their association with a specific study, enabling the retrieval of members that are enrolled in a particular study within the system. If not provided, member data may be retrieved without any study-specific filtering, allowing for a broader retrieval of member information based on other criteria or without any specific filtering based on study enrollments in the system.
int32Gratie?booleanLidVanVerdienste?booleanEreLid?booleanBegunstiger?booleanSuspended?booleanInactive?booleanIndicates whether to include inactive members in the retrieved member data. If set to true, both active and inactive members will be included in the response; if set to false, only active members will be included. This field allows for filtering members based on their active status, enabling the retrieval of either all members or only those that are currently active in the system based on the provided criteria in the request payload. The GetMembersDto ensures that member data is retrieved with the necessary information to effectively filter and manage member information based on their active status, providing a structured and validated approach to member retrieval in the application.
StudyType?stringDefines the type of a Study.
int32"Bachelor""Master"OK
application/json- response
[index: integer]?Defines the DTO for retrieving member information, containing all relevant details about a member, including personal information, contact details, and any associated data such as study enrollments and group memberships. The MemberResponseDTO is used to transfer comprehensive member data from the server to the client when retrieving member information, allowing for a complete representation of the member's details in the response payload. The MemberResponseDTO can include properties such as the member's unique identifier, name, email, phone number, address details, date of birth, mail subscriptions, preferred language, and any associated study enrollments or group memberships, providing a comprehensive view of the member data for the client application.
curl -X GET 'https://example.com/members'[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "studentNumber": "string", "firstName": "string", "lastName": "string", "email": "user@example.com", "phoneNumber": "string", "street": "string", "houseNumber": "string", "postalCode": "string", "city": "string", "dateOfBirth": "2019-08-24T14:15:22Z", "parentPhoneNumber": "string", "notes": "string", "registeredOn": "2019-08-24T14:15:22Z", "preferredLanguage": "NL", "studyEnrollments": [ { "id": 0, "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e", "memberName": "string", "studyId": 0, "studyTitle": "string", "studyType": "Bachelor", "enrollmentDate": "2019-08-24T14:15:22Z", "completionDate": "2019-08-24T14:15:22Z", "status": "Enrolled" } ], "groupMemberships": [ { "id": 0, "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e", "memberName": "string", "groupId": 0, "groupName": "string", "groupType": "Committee", "membershipYear": 0, "roleAliasId": 0, "roleAliasName": "string" } ], "gratie": true, "lidVanVerdienste": true, "ereLid": true, "begunstiger": true, "suspended": true, "profilePicturePath": "string" }]