Directory: Groups

get

Authorizations

BearerCookie

Path parameters

addressstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-addresses/{address} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
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

Authorizations

BearerCookie

Path parameters

addressstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/E01/directory/groups-addresses/{address} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-addresses/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-addresses HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
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

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-addresses/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "AddressIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Authorizations

BearerCookie

Path parameters

childGroupstring · uuidRequired

parentGroupstring · uuidRequired

parentstringRequired

childstringRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-connections/{parent}/{child} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "ChildGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "ParentGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

head

Authorizations

BearerCookie

Path parameters

childGroupstring · uuidRequired

parentGroupstring · uuidRequired

parentstringRequired

childstringRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/E01/directory/groups-connections/{parent}/{child} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-connections/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-connections HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "ChildGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "ParentGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-connections/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "ChildGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "ParentGroupIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Authorizations

BearerCookie

Path parameters

groupstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups/{group} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
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-08-29T22:13:52.371Z",
  "GroupExpiry": "2025-08-29T22:13:52.371Z",
  "LastChangeTime": "2025-08-29T22:13:52.371Z"
}

head

Authorizations

BearerCookie

Path parameters

groupstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/E01/directory/groups/{group} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
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-08-29T22:13:52.371Z",
    "GroupExpiry": "2025-08-29T22:13:52.371Z",
    "LastChangeTime": "2025-08-29T22:13:52.371Z"
  }
]

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Authorizations

BearerCookie

Path parameters

settingstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
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

Authorizations

BearerCookie

Path parameters

settingstringRequired

Body

application/jsontext/jsonapplication/*+json

GroupIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuid | nullableOptional

SettingIdentifierstring · uuidOptional

SettingNamestring | nullableOptional

SettingValuestring | nullableOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

put

HTTPcURLJavaScriptPython

PUT /v2/E01/directory/groups-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
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"
}

application/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

Path parameters

settingstring · uuidRequired

Responses

200

OK

No content

404

Not Found

delete

HTTPcURLJavaScriptPython

DELETE /v2/E01/directory/groups-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

No content

head

Authorizations

BearerCookie

Path parameters

settingstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/E01/directory/groups-fields/{setting} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-fields/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-fields HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
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

Authorizations

BearerCookie

Body

application/jsontext/jsonapplication/*+json

GroupIdentifierstring · uuidOptional

OrganizationIdentifierstring · uuid | nullableOptional

SettingIdentifierstring · uuidOptional

SettingNamestring | nullableOptional

SettingValuestring | nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

HTTPcURLJavaScriptPython

POST /v2/E01/directory/groups-fields HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
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"
}

application/jsontext/jsonapplication/*+json

{
  "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "OrganizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "SettingName": "text",
  "SettingValue": "text"
}

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-fields/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "SettingIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

get

Authorizations

BearerCookie

Path parameters

tagstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-tags/{tag} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "TagIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "GroupTag": "text"
}

head

Authorizations

BearerCookie

Path parameters

tagstring · uuidRequired

Responses

200

OK

application/json

Responseboolean

head

HTTPcURLJavaScriptPython

HEAD /v2/E01/directory/groups-tags/{tag} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

Responseinteger · int32

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-tags/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

1

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-tags HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "GroupIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "TagIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "GroupTag": "text"
  }
]

get

Authorizations

BearerCookie

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.PageSizeinteger · int32Optional

Filter.SortstringOptional

Filter.ExcludesstringOptional

Filter.IncludesstringOptional

Filter.FormatstringOptional

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v2/E01/directory/groups-tags/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "TagIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]