Directory: Groups
get
Path parameters
addressstring · uuidRequired
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-addresses/{address} HTTP/1.1
Host:
Accept: */*
200
OK
{
"AddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"AddressType": "text",
"City": "text",
"Country": "text",
"Description": "text",
"PostalCode": "text",
"Province": "text",
"Street1": "text",
"Street2": "text",
"Latitude": 1,
"Longitude": 1
}
head
Path parameters
addressstring · uuidRequired
Responses
200
OK
application/json
Responseboolean
head
HEAD /v2/e01/directory/groups-addresses/{address} HTTP/1.1
Host:
Accept: */*
200
OK
true
get
Query parameters
GroupIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
AddressTypestringOptional
CitystringOptional
CountrystringOptional
DescriptionstringOptional
PostalCodestringOptional
ProvincestringOptional
Street1stringOptional
Street2stringOptional
Latitudenumber · doubleOptional
Longitudenumber · doubleOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-addresses/count HTTP/1.1
Host:
Accept: */*
200
OK
{
"Count": 1
}
get
Query parameters
GroupIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
AddressTypestringOptional
CitystringOptional
CountrystringOptional
DescriptionstringOptional
PostalCodestringOptional
ProvincestringOptional
Street1stringOptional
Street2stringOptional
Latitudenumber · doubleOptional
Longitudenumber · doubleOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-addresses HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"AddressIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"AddressType": "text",
"City": "text",
"Country": "text",
"Description": "text",
"PostalCode": "text",
"Province": "text",
"Street1": "text",
"Street2": "text",
"Latitude": 1,
"Longitude": 1
}
]
get
Query parameters
GroupIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
AddressTypestringOptional
CitystringOptional
CountrystringOptional
DescriptionstringOptional
PostalCodestringOptional
ProvincestringOptional
Street1stringOptional
Street2stringOptional
Latitudenumber · doubleOptional
Longitudenumber · doubleOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-addresses/search HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"AddressIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
]
get
Path parameters
childGroupstring · uuidRequired
parentGroupstring · uuidRequired
parentstringRequired
childstringRequired
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-connections/{parent}/{child} HTTP/1.1
Host:
Accept: */*
200
OK
{
"ChildGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ParentGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
head
Path parameters
childGroupstring · uuidRequired
parentGroupstring · uuidRequired
parentstringRequired
childstringRequired
Responses
200
OK
application/json
Responseboolean
head
HEAD /v2/e01/directory/groups-connections/{parent}/{child} HTTP/1.1
Host:
Accept: */*
200
OK
true
get
Query parameters
OrganizationIdentifierstring · uuidOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-connections/count HTTP/1.1
Host:
Accept: */*
200
OK
{
"Count": 1
}
get
Query parameters
OrganizationIdentifierstring · uuidOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-connections HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"ChildGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ParentGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
]
get
Query parameters
OrganizationIdentifierstring · uuidOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-connections/search HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"ChildGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ParentGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
]
get
Path parameters
groupstring · uuidRequired
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups/{group} HTTP/1.1
Host:
Accept: */*
200
OK
{
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"MembershipProductIdentifier": "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",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ParentGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SurveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"AddNewUsersAutomatically": 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": "2025-07-16T19:47:31.226Z",
"GroupExpiry": "2025-07-16T19:47:31.226Z",
"LastChangeTime": "2025-07-16T19:47:31.226Z"
}
head
Path parameters
groupstring · uuidRequired
Responses
200
OK
application/json
Responseboolean
head
HEAD /v2/e01/directory/groups/{group} HTTP/1.1
Host:
Accept: */*
200
OK
true
get
Query parameters
MembershipProductIdentifierstring · uuidOptional
MessageToAdminWhenEventVenueChangedstring · uuidOptional
MessageToAdminWhenMembershipEndedstring · uuidOptional
MessageToAdminWhenMembershipStartedstring · uuidOptional
MessageToUserWhenMembershipEndedstring · uuidOptional
MessageToUserWhenMembershipStartedstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
ParentGroupIdentifierstring · uuidOptional
SurveyFormIdentifierstring · uuidOptional
AddNewUsersAutomaticallybooleanOptional
AllowSelfSubscriptionbooleanOptional
GroupCategorystringOptional
GroupCodestringOptional
GroupDescriptionstringOptional
GroupEmailstringOptional
GroupFaxstringOptional
GroupImagestringOptional
GroupIndustrystringOptional
GroupIndustryCommentstringOptional
GroupLabelstringOptional
GroupNamestringOptional
GroupOfficestringOptional
GroupPhonestringOptional
GroupRegionstringOptional
GroupSizestringOptional
GroupStatusstringOptional
GroupTypestringOptional
GroupWebSiteUrlstringOptional
LastChangeTypestringOptional
LastChangeUserstringOptional
LifetimeUnitstringOptional
ShippingPreferencestringOptional
SocialMediaUrlsstringOptional
SurveyNecessitystringOptional
GroupCapacityinteger · int32Optional
LifetimeQuantityinteger · int32Optional
GroupCreatedstring · date-timeOptional
GroupExpirystring · date-timeOptional
LastChangeTimestring · date-timeOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups/count HTTP/1.1
Host:
Accept: */*
200
OK
{
"Count": 1
}
get
Query parameters
MembershipProductIdentifierstring · uuidOptional
MessageToAdminWhenEventVenueChangedstring · uuidOptional
MessageToAdminWhenMembershipEndedstring · uuidOptional
MessageToAdminWhenMembershipStartedstring · uuidOptional
MessageToUserWhenMembershipEndedstring · uuidOptional
MessageToUserWhenMembershipStartedstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
ParentGroupIdentifierstring · uuidOptional
SurveyFormIdentifierstring · uuidOptional
AddNewUsersAutomaticallybooleanOptional
AllowSelfSubscriptionbooleanOptional
GroupCategorystringOptional
GroupCodestringOptional
GroupDescriptionstringOptional
GroupEmailstringOptional
GroupFaxstringOptional
GroupImagestringOptional
GroupIndustrystringOptional
GroupIndustryCommentstringOptional
GroupLabelstringOptional
GroupNamestringOptional
GroupOfficestringOptional
GroupPhonestringOptional
GroupRegionstringOptional
GroupSizestringOptional
GroupStatusstringOptional
GroupTypestringOptional
GroupWebSiteUrlstringOptional
LastChangeTypestringOptional
LastChangeUserstringOptional
LifetimeUnitstringOptional
ShippingPreferencestringOptional
SocialMediaUrlsstringOptional
SurveyNecessitystringOptional
GroupCapacityinteger · int32Optional
LifetimeQuantityinteger · int32Optional
GroupCreatedstring · date-timeOptional
GroupExpirystring · date-timeOptional
LastChangeTimestring · date-timeOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"MembershipProductIdentifier": "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",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"ParentGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SurveyFormIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"AddNewUsersAutomatically": 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": "2025-07-16T19:47:31.226Z",
"GroupExpiry": "2025-07-16T19:47:31.226Z",
"LastChangeTime": "2025-07-16T19:47:31.226Z"
}
]
get
Query parameters
MembershipProductIdentifierstring · uuidOptional
MessageToAdminWhenEventVenueChangedstring · uuidOptional
MessageToAdminWhenMembershipEndedstring · uuidOptional
MessageToAdminWhenMembershipStartedstring · uuidOptional
MessageToUserWhenMembershipEndedstring · uuidOptional
MessageToUserWhenMembershipStartedstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
ParentGroupIdentifierstring · uuidOptional
SurveyFormIdentifierstring · uuidOptional
AddNewUsersAutomaticallybooleanOptional
AllowSelfSubscriptionbooleanOptional
GroupCategorystringOptional
GroupCodestringOptional
GroupDescriptionstringOptional
GroupEmailstringOptional
GroupFaxstringOptional
GroupImagestringOptional
GroupIndustrystringOptional
GroupIndustryCommentstringOptional
GroupLabelstringOptional
GroupNamestringOptional
GroupOfficestringOptional
GroupPhonestringOptional
GroupRegionstringOptional
GroupSizestringOptional
GroupStatusstringOptional
GroupTypestringOptional
GroupWebSiteUrlstringOptional
LastChangeTypestringOptional
LastChangeUserstringOptional
LifetimeUnitstringOptional
ShippingPreferencestringOptional
SocialMediaUrlsstringOptional
SurveyNecessitystringOptional
GroupCapacityinteger · int32Optional
LifetimeQuantityinteger · int32Optional
GroupCreatedstring · date-timeOptional
GroupExpirystring · date-timeOptional
LastChangeTimestring · date-timeOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups/search HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
]
get
Path parameters
settingstring · uuidRequired
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-fields/{setting} HTTP/1.1
Host:
Accept: */*
200
OK
{
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SettingName": "text",
"SettingValue": "text"
}
put
Path parameters
settingstringRequired
Body
GroupIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuid | nullableOptional
SettingIdentifierstring · uuidOptional
SettingNamestring | nullableOptional
SettingValuestring | nullableOptional
Responses
200
OK
400
Bad Request
application/json
404
Not Found
application/json
put
PUT /v2/e01/directory/groups-fields/{setting} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 224
{
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SettingName": "text",
"SettingValue": "text"
}
No content
delete
Path parameters
settingstring · uuidRequired
Responses
200
OK
404
Not Found
application/json
delete
DELETE /v2/e01/directory/groups-fields/{setting} HTTP/1.1
Host:
Accept: */*
No content
head
Path parameters
settingstring · uuidRequired
Responses
200
OK
application/json
Responseboolean
head
HEAD /v2/e01/directory/groups-fields/{setting} HTTP/1.1
Host:
Accept: */*
200
OK
true
get
Query parameters
GroupIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
SettingNamestringOptional
SettingValuestringOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-fields/count HTTP/1.1
Host:
Accept: */*
200
OK
{
"Count": 1
}
get
Query parameters
GroupIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
SettingNamestringOptional
SettingValuestringOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-fields HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SettingName": "text",
"SettingValue": "text"
}
]
post
Body
GroupIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuid | nullableOptional
SettingIdentifierstring · uuidOptional
SettingNamestring | nullableOptional
SettingValuestring | nullableOptional
Responses
201
Created
application/json
400
Bad Request
application/json
post
POST /v2/e01/directory/groups-fields HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 224
{
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SettingName": "text",
"SettingValue": "text"
}
{
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"SettingName": "text",
"SettingValue": "text"
}
get
Query parameters
GroupIdentifierstring · uuidOptional
OrganizationIdentifierstring · uuidOptional
SettingNamestringOptional
SettingValuestringOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-fields/search HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
]
get
Path parameters
tagstring · uuidRequired
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-tags/{tag} HTTP/1.1
Host:
Accept: */*
200
OK
{
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"TagIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GroupTag": "text"
}
head
Path parameters
tagstring · uuidRequired
Responses
200
OK
application/json
Responseboolean
head
HEAD /v2/e01/directory/groups-tags/{tag} HTTP/1.1
Host:
Accept: */*
200
OK
true
get
Query parameters
GroupIdentifierstring · uuidOptional
GroupTagstringOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-tags/count HTTP/1.1
Host:
Accept: */*
200
OK
{
"Count": 1
}
get
Query parameters
GroupIdentifierstring · uuidOptional
GroupTagstringOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-tags HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"TagIdentifier": "123e4567-e89b-12d3-a456-426614174000",
"GroupTag": "text"
}
]
get
Query parameters
GroupIdentifierstring · uuidOptional
GroupTagstringOptional
Identifierstring · uuidOptional
Origin.Whenstring · date-timeOptional
Origin.Organizationstring · uuidOptional
Origin.Userstring · uuidOptional
Origin.Proxystring · uuidOptional
Origin.DescriptionstringOptional
Origin.ReasonstringOptional
Origin.SourcestringOptional
Filter.Pageinteger · int32Optional
Filter.Takeinteger · int32Optional
Filter.SortstringOptional
Filter.ExcludesstringOptional
Filter.IncludesstringOptional
Filter.FormatstringOptional
Pageinteger · int32Optional
Takeinteger · int32Optional
SortstringOptional
ExcludesstringOptional
IncludesstringOptional
FormatstringOptional
Responses
200
OK
application/json
get
GET /v2/e01/directory/groups-tags/search HTTP/1.1
Host:
Accept: */*
200
OK
[
{
"TagIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}
]
Was this helpful?