Directory API: Groups

Retrieves one specific group

get
Authorizations
BearerstringRequired
Path parameters
groupstring · uuidRequired
Responses
chevron-right
200

OK

get
/api/directory/groups/{group}
200

OK

Checks for the existence of one specific group

head
Authorizations
BearerstringRequired
Path parameters
groupstring · uuidRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/directory/groups/{group}
200

OK

Collects the list of groups that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
membershipProductIdstring · uuid · nullableOptional
messageToAdminWhenEventVenueChangedstring · uuid · nullableOptional
messageToAdminWhenMembershipEndedstring · uuid · nullableOptional
messageToAdminWhenMembershipStartedstring · uuid · nullableOptional
messageToUserWhenMembershipEndedstring · uuid · nullableOptional
messageToUserWhenMembershipStartedstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
parentGroupIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
addNewUsersAutomaticallyboolean · nullableOptional
allowJoinGroupUsingLinkboolean · nullableOptional
allowSelfSubscriptionboolean · nullableOptional
groupCategorystring · nullableOptional
groupCodestring · nullableOptional
groupDescriptionstring · nullableOptional
groupEmailstring · nullableOptional
groupFaxstring · nullableOptional
groupImagestring · nullableOptional
groupIndustrystring · nullableOptional
groupIndustryCommentstring · nullableOptional
groupLabelstring · nullableOptional
groupNamestring · nullableOptional
groupOfficestring · nullableOptional
groupPhonestring · nullableOptional
groupRegionstring · nullableOptional
groupSizestring · nullableOptional
groupStatusstring · nullableOptional
groupTypestring · nullableOptional
groupWebSiteUrlstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
lifetimeUnitstring · nullableOptional
shippingPreferencestring · nullableOptional
socialMediaUrlsstring · nullableOptional
surveyNecessitystring · nullableOptional
groupCapacityinteger · int32 · nullableOptional
lifetimeQuantityinteger · int32 · nullableOptional
groupCreatedstring · date-time · nullableOptional
groupExpirystring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
Responses
chevron-right
200

OK

post
/api/directory/groups/collect
200

OK

Counts the groups that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
membershipProductIdstring · uuid · nullableOptional
messageToAdminWhenEventVenueChangedstring · uuid · nullableOptional
messageToAdminWhenMembershipEndedstring · uuid · nullableOptional
messageToAdminWhenMembershipStartedstring · uuid · nullableOptional
messageToUserWhenMembershipEndedstring · uuid · nullableOptional
messageToUserWhenMembershipStartedstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
parentGroupIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
addNewUsersAutomaticallyboolean · nullableOptional
allowJoinGroupUsingLinkboolean · nullableOptional
allowSelfSubscriptionboolean · nullableOptional
groupCategorystring · nullableOptional
groupCodestring · nullableOptional
groupDescriptionstring · nullableOptional
groupEmailstring · nullableOptional
groupFaxstring · nullableOptional
groupImagestring · nullableOptional
groupIndustrystring · nullableOptional
groupIndustryCommentstring · nullableOptional
groupLabelstring · nullableOptional
groupNamestring · nullableOptional
groupOfficestring · nullableOptional
groupPhonestring · nullableOptional
groupRegionstring · nullableOptional
groupSizestring · nullableOptional
groupStatusstring · nullableOptional
groupTypestring · nullableOptional
groupWebSiteUrlstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
lifetimeUnitstring · nullableOptional
shippingPreferencestring · nullableOptional
socialMediaUrlsstring · nullableOptional
surveyNecessitystring · nullableOptional
groupCapacityinteger · int32 · nullableOptional
lifetimeQuantityinteger · int32 · nullableOptional
groupCreatedstring · date-time · nullableOptional
groupExpirystring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
Responses
chevron-right
200

OK

post
/api/directory/groups/count
200

OK

Downloads the list of groups that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
membershipProductIdstring · uuid · nullableOptional
messageToAdminWhenEventVenueChangedstring · uuid · nullableOptional
messageToAdminWhenMembershipEndedstring · uuid · nullableOptional
messageToAdminWhenMembershipStartedstring · uuid · nullableOptional
messageToUserWhenMembershipEndedstring · uuid · nullableOptional
messageToUserWhenMembershipStartedstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
parentGroupIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
addNewUsersAutomaticallyboolean · nullableOptional
allowJoinGroupUsingLinkboolean · nullableOptional
allowSelfSubscriptionboolean · nullableOptional
groupCategorystring · nullableOptional
groupCodestring · nullableOptional
groupDescriptionstring · nullableOptional
groupEmailstring · nullableOptional
groupFaxstring · nullableOptional
groupImagestring · nullableOptional
groupIndustrystring · nullableOptional
groupIndustryCommentstring · nullableOptional
groupLabelstring · nullableOptional
groupNamestring · nullableOptional
groupOfficestring · nullableOptional
groupPhonestring · nullableOptional
groupRegionstring · nullableOptional
groupSizestring · nullableOptional
groupStatusstring · nullableOptional
groupTypestring · nullableOptional
groupWebSiteUrlstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
lifetimeUnitstring · nullableOptional
shippingPreferencestring · nullableOptional
socialMediaUrlsstring · nullableOptional
surveyNecessitystring · nullableOptional
groupCapacityinteger · int32 · nullableOptional
lifetimeQuantityinteger · int32 · nullableOptional
groupCreatedstring · date-time · nullableOptional
groupExpirystring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/directory/groups/download
200

OK

No content

Searches for the list of groups that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
membershipProductIdstring · uuid · nullableOptional
messageToAdminWhenEventVenueChangedstring · uuid · nullableOptional
messageToAdminWhenMembershipEndedstring · uuid · nullableOptional
messageToAdminWhenMembershipStartedstring · uuid · nullableOptional
messageToUserWhenMembershipEndedstring · uuid · nullableOptional
messageToUserWhenMembershipStartedstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
parentGroupIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
addNewUsersAutomaticallyboolean · nullableOptional
allowJoinGroupUsingLinkboolean · nullableOptional
allowSelfSubscriptionboolean · nullableOptional
groupCategorystring · nullableOptional
groupCodestring · nullableOptional
groupDescriptionstring · nullableOptional
groupEmailstring · nullableOptional
groupFaxstring · nullableOptional
groupImagestring · nullableOptional
groupIndustrystring · nullableOptional
groupIndustryCommentstring · nullableOptional
groupLabelstring · nullableOptional
groupNamestring · nullableOptional
groupOfficestring · nullableOptional
groupPhonestring · nullableOptional
groupRegionstring · nullableOptional
groupSizestring · nullableOptional
groupStatusstring · nullableOptional
groupTypestring · nullableOptional
groupWebSiteUrlstring · nullableOptional
lastChangeTypestring · nullableOptional
lastChangeUserstring · nullableOptional
lifetimeUnitstring · nullableOptional
shippingPreferencestring · nullableOptional
socialMediaUrlsstring · nullableOptional
surveyNecessitystring · nullableOptional
groupCapacityinteger · int32 · nullableOptional
lifetimeQuantityinteger · int32 · nullableOptional
groupCreatedstring · date-time · nullableOptional
groupExpirystring · date-time · nullableOptional
lastChangeTimestring · date-time · nullableOptional
Responses
chevron-right
200

OK

post
/api/directory/groups/search
200

OK

Last updated

Was this helpful?