Contacts API: Groups

Retrieves one specific group

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

groupstring · uuidRequired

Responses

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

get

/api/contacts/groups/{group}

HTTPcURLJavaScriptPython

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

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Checks for the existence of one specific group

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

groupstring · uuidRequired

Responses

200

OK

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

head

/api/contacts/groups/{group}

HTTPcURLJavaScriptPython

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

Authorizations

BearerCookie

BearerstringRequired

Body

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

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

OK

application/jsontext/json

post

/api/contacts/groups/collect

HTTPcURLJavaScriptPython

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

{
  "GroupCreatedSince": "2026-05-07T18:19:45.102Z",
  "GroupCreatedBefore": "2026-05-07T18:19:45.102Z",
  "GroupExpirySince": "2026-05-07T18:19:45.102Z",
  "GroupExpiryBefore": "2026-05-07T18:19:45.102Z",
  "LastChangeTimeSince": "2026-05-07T18:19:45.102Z",
  "LastChangeTimeBefore": "2026-05-07T18:19:45.102Z"
}

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",
    "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-05-07T18:19:45.102Z",
    "GroupExpiry": "2026-05-07T18:19:45.102Z",
    "LastChangeTime": "2026-05-07T18:19:45.102Z"
  }
]

Counts the groups that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

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

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

OK

application/jsontext/json

post

/api/contacts/groups/count

HTTPcURLJavaScriptPython

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

{
  "GroupCreatedSince": "2026-05-07T18:19:45.102Z",
  "GroupCreatedBefore": "2026-05-07T18:19:45.102Z",
  "GroupExpirySince": "2026-05-07T18:19:45.102Z",
  "GroupExpiryBefore": "2026-05-07T18:19:45.102Z",
  "LastChangeTimeSince": "2026-05-07T18:19:45.102Z",
  "LastChangeTimeBefore": "2026-05-07T18:19:45.102Z"
}

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

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

OK

post

/api/contacts/groups/download

HTTPcURLJavaScriptPython

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

{
  "GroupCreatedSince": "2026-05-07T18:19:45.102Z",
  "GroupCreatedBefore": "2026-05-07T18:19:45.102Z",
  "GroupExpirySince": "2026-05-07T18:19:45.102Z",
  "GroupExpiryBefore": "2026-05-07T18:19:45.102Z",
  "LastChangeTimeSince": "2026-05-07T18:19:45.102Z",
  "LastChangeTimeBefore": "2026-05-07T18:19:45.102Z"
}

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

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

OK

application/jsontext/json

post

/api/contacts/groups/search

HTTPcURLJavaScriptPython

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

{
  "GroupCreatedSince": "2026-05-07T18:19:45.102Z",
  "GroupCreatedBefore": "2026-05-07T18:19:45.102Z",
  "GroupExpirySince": "2026-05-07T18:19:45.102Z",
  "GroupExpiryBefore": "2026-05-07T18:19:45.102Z",
  "LastChangeTimeSince": "2026-05-07T18:19:45.102Z",
  "LastChangeTimeBefore": "2026-05-07T18:19:45.102Z"
}

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

200

OK

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