Contacts API: Groups

Retrieves one specific group

get

Authorizations

BearerstringRequired

Path parameters

groupstring · uuidRequired

Responses

200

GroupIdstring · uuidOptional

MembershipProductIdstring · uuid · nullableOptional

MessageToAdminWhenEventVenueChangedstring · uuid · nullableOptional

MessageToAdminWhenMembershipEndedstring · uuid · nullableOptional

MessageToAdminWhenMembershipStartedstring · uuid · nullableOptional

MessageToUserWhenMembershipEndedstring · uuid · nullableOptional

MessageToUserWhenMembershipStartedstring · uuid · nullableOptional

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

404

Not Found

get/api/contacts/groups/{group}

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

{
  "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",
  "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-08-10T15:31:28.903Z",
  "GroupExpiry": "2026-08-10T15:31:28.903Z",
  "LastChangeTime": "2026-08-10T15:31:28.903Z"
}

Checks for the existence of one specific group

head

Authorizations

BearerstringRequired

Path parameters

groupstring · uuidRequired

Responses

200

No content

404

Not Found

head/api/contacts/groups/{group}

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

No content

Collects the list of groups that match specific criteria

post

Use LastChangeTimeSince and LastChangeTimeBefore to restrict the result set to groups modified within a specific window. Both parameters accept ISO 8601 date-time values, for example "2026-07-06T14:00:00+00:00". LastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive.

Authorizations

BearerstringRequired

Body

GroupCodestring · nullableOptional

GroupCreatedSincestring · date-time · nullableOptional

GroupCreatedBeforestring · date-time · nullableOptional

GroupExpirySincestring · date-time · nullableOptional

GroupExpiryBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

GroupIdstring · uuidOptional

MembershipProductIdstring · uuid · nullableOptional

MessageToAdminWhenEventVenueChangedstring · uuid · nullableOptional

MessageToAdminWhenMembershipEndedstring · uuid · nullableOptional

MessageToAdminWhenMembershipStartedstring · uuid · nullableOptional

MessageToUserWhenMembershipEndedstring · uuid · nullableOptional

MessageToUserWhenMembershipStartedstring · uuid · nullableOptional

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/contacts/groups/collect

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

{
  "GroupCode": "text",
  "GroupCreatedSince": "2026-08-10T15:31:28.903Z",
  "GroupCreatedBefore": "2026-08-10T15:31:28.903Z",
  "GroupExpirySince": "2026-08-10T15:31:28.903Z",
  "GroupExpiryBefore": "2026-08-10T15:31:28.903Z",
  "LastChangeTimeSince": "2026-08-10T15:31:28.903Z",
  "LastChangeTimeBefore": "2026-08-10T15:31:28.903Z"
}

200

[
  {
    "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",
    "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-08-10T15:31:28.903Z",
    "GroupExpiry": "2026-08-10T15:31:28.903Z",
    "LastChangeTime": "2026-08-10T15:31:28.903Z"
  }
]

Counts the groups that match specific criteria

post

Use LastChangeTimeSince and LastChangeTimeBefore to restrict the count to groups modified within a specific window. Both parameters accept ISO 8601 date-time values, for example "2026-07-06T14:00:00+00:00". LastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive.

Authorizations

BearerstringRequired

Body

GroupCodestring · nullableOptional

GroupCreatedSincestring · date-time · nullableOptional

GroupCreatedBeforestring · date-time · nullableOptional

GroupExpirySincestring · date-time · nullableOptional

GroupExpiryBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

Countinteger · int32Optional

Summarystring · nullableOptional

post/api/contacts/groups/count

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

{
  "GroupCode": "text",
  "GroupCreatedSince": "2026-08-10T15:31:28.903Z",
  "GroupCreatedBefore": "2026-08-10T15:31:28.903Z",
  "GroupExpirySince": "2026-08-10T15:31:28.903Z",
  "GroupExpiryBefore": "2026-08-10T15:31:28.903Z",
  "LastChangeTimeSince": "2026-08-10T15:31:28.903Z",
  "LastChangeTimeBefore": "2026-08-10T15:31:28.903Z"
}

200

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of groups that match specific criteria

post

Use LastChangeTimeSince and LastChangeTimeBefore to download only groups modified within a specific window, which is useful for incremental integrations that already hold most of the data. Both parameters accept ISO 8601 date-time values, for example "2026-07-06T14:00:00+00:00". LastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive. When polling for deltas, subtract a small overlap (for example five minutes) from the previous poll time to allow for projection lag.

Authorizations

BearerstringRequired

Body

GroupCodestring · nullableOptional

GroupCreatedSincestring · date-time · nullableOptional

GroupCreatedBeforestring · date-time · nullableOptional

GroupExpirySincestring · date-time · nullableOptional

GroupExpiryBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

No content

post/api/contacts/groups/download

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

{
  "GroupCode": "text",
  "GroupCreatedSince": "2026-08-10T15:31:28.903Z",
  "GroupCreatedBefore": "2026-08-10T15:31:28.903Z",
  "GroupExpirySince": "2026-08-10T15:31:28.903Z",
  "GroupExpiryBefore": "2026-08-10T15:31:28.903Z",
  "LastChangeTimeSince": "2026-08-10T15:31:28.903Z",
  "LastChangeTimeBefore": "2026-08-10T15:31:28.903Z"
}

200

No content

Searches for the list of groups that match specific criteria

post

Authorizations

BearerstringRequired

Body

GroupCodestring · nullableOptional

GroupCreatedSincestring · date-time · nullableOptional

GroupCreatedBeforestring · date-time · nullableOptional

GroupExpirySincestring · date-time · nullableOptional

GroupExpiryBeforestring · date-time · nullableOptional

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

GroupIdstring · uuidOptional

GroupNamestring · nullableOptional

post/api/contacts/groups/search

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

{
  "GroupCode": "text",
  "GroupCreatedSince": "2026-08-10T15:31:28.903Z",
  "GroupCreatedBefore": "2026-08-10T15:31:28.903Z",
  "GroupExpirySince": "2026-08-10T15:31:28.903Z",
  "GroupExpiryBefore": "2026-08-10T15:31:28.903Z",
  "LastChangeTimeSince": "2026-08-10T15:31:28.903Z",
  "LastChangeTimeBefore": "2026-08-10T15:31:28.903Z"
}

200

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

PreviousAssets API: Translations NextContacts API: Memberships

Last updated 2 days ago

Was this helpful?