Directory API: Groups

Retrieves one specific group

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

groupstring · uuidRequired

Responses

200

OK

application/jsontext/json

groupIdstring · uuidOptional

membershipProductIdstring · uuid · nullableOptional

messageToAdminWhenEventVenueChangedstring · uuid · nullableOptional

messageToAdminWhenMembershipEndedstring · uuid · nullableOptional

messageToAdminWhenMembershipStartedstring · uuid · nullableOptional

messageToUserWhenMembershipEndedstring · uuid · nullableOptional

messageToUserWhenMembershipStartedstring · uuid · nullableOptional

organizationIdstring · uuidOptional

parentGroupIdstring · uuid · nullableOptional

surveyFormIdstring · uuid · nullableOptional

groupStatusItemIdstring · uuid · nullableOptional

addNewUsersAutomaticallybooleanOptional

allowJoinGroupUsingLinkbooleanOptional

allowSelfSubscriptionbooleanOptional

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

groupTypestring · nullableOptional

groupWebSiteUrlstring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

lifetimeUnitstring · nullableOptional

shippingPreferencestring · nullableOptional

socialMediaUrlsstring · nullableOptional

surveyNecessitystring · nullableOptional

groupCapacityinteger · int32 · nullableOptional

lifetimeQuantityinteger · int32 · nullableOptional

groupCreatedstring · date-timeOptional

groupExpirystring · date-time · nullableOptional

lastChangeTimestring · date-timeOptional

get

/api/directory/groups/{group}

HTTPcURLJavaScriptPython

GET /v2/e01/api/directory/groups/{group} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "groupId": "123e4567-e89b-12d3-a456-426614174000",
  "membershipProductId": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenEventVenueChanged": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
  "messageToUserWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
  "messageToUserWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "parentGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "groupStatusItemId": "123e4567-e89b-12d3-a456-426614174000",
  "addNewUsersAutomatically": true,
  "allowJoinGroupUsingLink": true,
  "allowSelfSubscription": true,
  "groupCategory": "text",
  "groupCode": "text",
  "groupDescription": "text",
  "groupEmail": "text",
  "groupFax": "text",
  "groupImage": "text",
  "groupIndustry": "text",
  "groupIndustryComment": "text",
  "groupLabel": "text",
  "groupName": "text",
  "groupOffice": "text",
  "groupPhone": "text",
  "groupRegion": "text",
  "groupSize": "text",
  "groupType": "text",
  "groupWebSiteUrl": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "lifetimeUnit": "text",
  "shippingPreference": "text",
  "socialMediaUrls": "text",
  "surveyNecessity": "text",
  "groupCapacity": 1,
  "lifetimeQuantity": 1,
  "groupCreated": "2026-03-16T02:00:15.534Z",
  "groupExpiry": "2026-03-16T02:00:15.534Z",
  "lastChangeTime": "2026-03-16T02:00:15.534Z"
}

Checks for the existence of one specific group

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

groupstring · uuidRequired

Responses

200

OK

application/jsontext/json

booleanOptional

head

/api/directory/groups/{group}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/directory/groups/{group} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of groups that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

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

200

OK

application/jsontext/json

groupIdstring · uuidOptional

membershipProductIdstring · uuid · nullableOptional

messageToAdminWhenEventVenueChangedstring · uuid · nullableOptional

messageToAdminWhenMembershipEndedstring · uuid · nullableOptional

messageToAdminWhenMembershipStartedstring · uuid · nullableOptional

messageToUserWhenMembershipEndedstring · uuid · nullableOptional

messageToUserWhenMembershipStartedstring · uuid · nullableOptional

organizationIdstring · uuidOptional

parentGroupIdstring · uuid · nullableOptional

surveyFormIdstring · uuid · nullableOptional

groupStatusItemIdstring · uuid · nullableOptional

addNewUsersAutomaticallybooleanOptional

allowJoinGroupUsingLinkbooleanOptional

allowSelfSubscriptionbooleanOptional

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

groupTypestring · nullableOptional

groupWebSiteUrlstring · nullableOptional

lastChangeTypestring · nullableOptional

lastChangeUserstring · nullableOptional

lifetimeUnitstring · nullableOptional

shippingPreferencestring · nullableOptional

socialMediaUrlsstring · nullableOptional

surveyNecessitystring · nullableOptional

groupCapacityinteger · int32 · nullableOptional

lifetimeQuantityinteger · int32 · nullableOptional

groupCreatedstring · date-timeOptional

groupExpirystring · date-time · nullableOptional

lastChangeTimestring · date-timeOptional

post

/api/directory/groups/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/directory/groups/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1815

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-16T02:00:15.534Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "membershipProductId": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenEventVenueChanged": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
  "messageToUserWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
  "messageToUserWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "parentGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "addNewUsersAutomatically": true,
  "allowJoinGroupUsingLink": true,
  "allowSelfSubscription": true,
  "groupCategory": "text",
  "groupCode": "text",
  "groupDescription": "text",
  "groupEmail": "text",
  "groupFax": "text",
  "groupImage": "text",
  "groupIndustry": "text",
  "groupIndustryComment": "text",
  "groupLabel": "text",
  "groupName": "text",
  "groupOffice": "text",
  "groupPhone": "text",
  "groupRegion": "text",
  "groupSize": "text",
  "groupStatus": "text",
  "groupType": "text",
  "groupWebSiteUrl": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "lifetimeUnit": "text",
  "shippingPreference": "text",
  "socialMediaUrls": "text",
  "surveyNecessity": "text",
  "groupCapacity": 1,
  "lifetimeQuantity": 1,
  "groupCreated": "2026-03-16T02:00:15.534Z",
  "groupExpiry": "2026-03-16T02:00:15.534Z",
  "lastChangeTime": "2026-03-16T02:00:15.534Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "groupId": "123e4567-e89b-12d3-a456-426614174000",
    "membershipProductId": "123e4567-e89b-12d3-a456-426614174000",
    "messageToAdminWhenEventVenueChanged": "123e4567-e89b-12d3-a456-426614174000",
    "messageToAdminWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
    "messageToAdminWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
    "messageToUserWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
    "messageToUserWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "parentGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "surveyFormId": "123e4567-e89b-12d3-a456-426614174000",
    "groupStatusItemId": "123e4567-e89b-12d3-a456-426614174000",
    "addNewUsersAutomatically": true,
    "allowJoinGroupUsingLink": true,
    "allowSelfSubscription": true,
    "groupCategory": "text",
    "groupCode": "text",
    "groupDescription": "text",
    "groupEmail": "text",
    "groupFax": "text",
    "groupImage": "text",
    "groupIndustry": "text",
    "groupIndustryComment": "text",
    "groupLabel": "text",
    "groupName": "text",
    "groupOffice": "text",
    "groupPhone": "text",
    "groupRegion": "text",
    "groupSize": "text",
    "groupType": "text",
    "groupWebSiteUrl": "text",
    "lastChangeType": "text",
    "lastChangeUser": "text",
    "lifetimeUnit": "text",
    "shippingPreference": "text",
    "socialMediaUrls": "text",
    "surveyNecessity": "text",
    "groupCapacity": 1,
    "lifetimeQuantity": 1,
    "groupCreated": "2026-03-16T02:00:15.534Z",
    "groupExpiry": "2026-03-16T02:00:15.534Z",
    "lastChangeTime": "2026-03-16T02:00:15.534Z"
  }
]

Counts the groups that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

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

200

OK

application/jsontext/json

countinteger · int32Optional

summarystring · nullableOptional

post

/api/directory/groups/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/directory/groups/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1815

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-16T02:00:15.534Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "membershipProductId": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenEventVenueChanged": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
  "messageToUserWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
  "messageToUserWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "parentGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "addNewUsersAutomatically": true,
  "allowJoinGroupUsingLink": true,
  "allowSelfSubscription": true,
  "groupCategory": "text",
  "groupCode": "text",
  "groupDescription": "text",
  "groupEmail": "text",
  "groupFax": "text",
  "groupImage": "text",
  "groupIndustry": "text",
  "groupIndustryComment": "text",
  "groupLabel": "text",
  "groupName": "text",
  "groupOffice": "text",
  "groupPhone": "text",
  "groupRegion": "text",
  "groupSize": "text",
  "groupStatus": "text",
  "groupType": "text",
  "groupWebSiteUrl": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "lifetimeUnit": "text",
  "shippingPreference": "text",
  "socialMediaUrls": "text",
  "surveyNecessity": "text",
  "groupCapacity": 1,
  "lifetimeQuantity": 1,
  "groupCreated": "2026-03-16T02:00:15.534Z",
  "groupExpiry": "2026-03-16T02:00:15.534Z",
  "lastChangeTime": "2026-03-16T02:00:15.534Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of groups that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

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

200

OK

No content

post

/api/directory/groups/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/directory/groups/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1815

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-16T02:00:15.534Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "membershipProductId": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenEventVenueChanged": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
  "messageToUserWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
  "messageToUserWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "parentGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "addNewUsersAutomatically": true,
  "allowJoinGroupUsingLink": true,
  "allowSelfSubscription": true,
  "groupCategory": "text",
  "groupCode": "text",
  "groupDescription": "text",
  "groupEmail": "text",
  "groupFax": "text",
  "groupImage": "text",
  "groupIndustry": "text",
  "groupIndustryComment": "text",
  "groupLabel": "text",
  "groupName": "text",
  "groupOffice": "text",
  "groupPhone": "text",
  "groupRegion": "text",
  "groupSize": "text",
  "groupStatus": "text",
  "groupType": "text",
  "groupWebSiteUrl": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "lifetimeUnit": "text",
  "shippingPreference": "text",
  "socialMediaUrls": "text",
  "surveyNecessity": "text",
  "groupCapacity": 1,
  "lifetimeQuantity": 1,
  "groupCreated": "2026-03-16T02:00:15.534Z",
  "groupExpiry": "2026-03-16T02:00:15.534Z",
  "lastChangeTime": "2026-03-16T02:00:15.534Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of groups that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

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

200

OK

application/jsontext/json

groupIdstring · uuidOptional

groupNamestring · nullableOptional

post

/api/directory/groups/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/directory/groups/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1815

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-03-16T02:00:15.534Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "membershipProductId": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenEventVenueChanged": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
  "messageToAdminWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
  "messageToUserWhenMembershipEnded": "123e4567-e89b-12d3-a456-426614174000",
  "messageToUserWhenMembershipStarted": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "parentGroupId": "123e4567-e89b-12d3-a456-426614174000",
  "surveyFormId": "123e4567-e89b-12d3-a456-426614174000",
  "addNewUsersAutomatically": true,
  "allowJoinGroupUsingLink": true,
  "allowSelfSubscription": true,
  "groupCategory": "text",
  "groupCode": "text",
  "groupDescription": "text",
  "groupEmail": "text",
  "groupFax": "text",
  "groupImage": "text",
  "groupIndustry": "text",
  "groupIndustryComment": "text",
  "groupLabel": "text",
  "groupName": "text",
  "groupOffice": "text",
  "groupPhone": "text",
  "groupRegion": "text",
  "groupSize": "text",
  "groupStatus": "text",
  "groupType": "text",
  "groupWebSiteUrl": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "lifetimeUnit": "text",
  "shippingPreference": "text",
  "socialMediaUrls": "text",
  "surveyNecessity": "text",
  "groupCapacity": 1,
  "lifetimeQuantity": 1,
  "groupCreated": "2026-03-16T02:00:15.534Z",
  "groupExpiry": "2026-03-16T02:00:15.534Z",
  "lastChangeTime": "2026-03-16T02:00:15.534Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "groupId": "123e4567-e89b-12d3-a456-426614174000",
    "groupName": "text"
  }
]