> For the complete documentation index, see [llms.txt](https://docs.shiftiq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shiftiq.com/developers/api-v2/navigating-the-api/contacts-api-groups.md).

# Contacts API: Groups

## GET /api/contacts/groups/{group}

> Retrieves one specific group

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"GroupModel":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"MembershipProductId":{"type":"string","format":"uuid","nullable":true},"MessageToAdminWhenEventVenueChanged":{"type":"string","format":"uuid","nullable":true},"MessageToAdminWhenMembershipEnded":{"type":"string","format":"uuid","nullable":true},"MessageToAdminWhenMembershipStarted":{"type":"string","format":"uuid","nullable":true},"MessageToUserWhenMembershipEnded":{"type":"string","format":"uuid","nullable":true},"MessageToUserWhenMembershipStarted":{"type":"string","format":"uuid","nullable":true},"ParentGroupId":{"type":"string","format":"uuid","nullable":true},"SurveyFormId":{"type":"string","format":"uuid","nullable":true},"GroupStatusItemId":{"type":"string","format":"uuid","nullable":true},"AddNewUsersAutomatically":{"type":"boolean"},"AllowJoinGroupUsingLink":{"type":"boolean"},"AllowSelfSubscription":{"type":"boolean"},"GroupCategory":{"type":"string","nullable":true},"GroupCode":{"type":"string","nullable":true},"GroupDescription":{"type":"string","nullable":true},"GroupEmail":{"type":"string","nullable":true},"GroupFax":{"type":"string","nullable":true},"GroupImage":{"type":"string","nullable":true},"GroupIndustry":{"type":"string","nullable":true},"GroupIndustryComment":{"type":"string","nullable":true},"GroupLabel":{"type":"string","nullable":true},"GroupName":{"type":"string","nullable":true},"GroupOffice":{"type":"string","nullable":true},"GroupPhone":{"type":"string","nullable":true},"GroupRegion":{"type":"string","nullable":true},"GroupSize":{"type":"string","nullable":true},"GroupType":{"type":"string","nullable":true},"GroupWebSiteUrl":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"LifetimeUnit":{"type":"string","nullable":true},"ShippingPreference":{"type":"string","nullable":true},"SocialMediaUrls":{"type":"string","nullable":true},"SurveyNecessity":{"type":"string","nullable":true},"GroupCapacity":{"type":"integer","format":"int32","nullable":true},"LifetimeQuantity":{"type":"integer","format":"int32","nullable":true},"GroupCreated":{"type":"string","format":"date-time"},"GroupExpiry":{"type":"string","format":"date-time","nullable":true},"LastChangeTime":{"type":"string","format":"date-time"}},"additionalProperties":false},"ProblemDetails":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/contacts/groups/{group}":{"get":{"tags":["Contacts API: Groups"],"summary":"Retrieves one specific group","operationId":"retrieveGroup","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupModel"}},"text/json":{"schema":{"$ref":"#/components/schemas/GroupModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

## HEAD /api/contacts/groups/{group}

> Checks for the existence of one specific group

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"ProblemDetails":{"type":"object","properties":{"Type":{"type":"string","nullable":true},"Title":{"type":"string","nullable":true},"Status":{"type":"integer","format":"int32","nullable":true},"Detail":{"type":"string","nullable":true},"Instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/contacts/groups/{group}":{"head":{"tags":["Contacts API: Groups"],"summary":"Checks for the existence of one specific group","operationId":"assertGroup","parameters":[{"name":"group","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}}}
```

## Collects the list of groups that match specific criteria

> 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.

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"CollectGroups":{"type":"object","properties":{"GroupCode":{"type":"string","nullable":true},"GroupCreatedSince":{"type":"string","format":"date-time","nullable":true},"GroupCreatedBefore":{"type":"string","format":"date-time","nullable":true},"GroupExpirySince":{"type":"string","format":"date-time","nullable":true},"GroupExpiryBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"GroupModel":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"MembershipProductId":{"type":"string","format":"uuid","nullable":true},"MessageToAdminWhenEventVenueChanged":{"type":"string","format":"uuid","nullable":true},"MessageToAdminWhenMembershipEnded":{"type":"string","format":"uuid","nullable":true},"MessageToAdminWhenMembershipStarted":{"type":"string","format":"uuid","nullable":true},"MessageToUserWhenMembershipEnded":{"type":"string","format":"uuid","nullable":true},"MessageToUserWhenMembershipStarted":{"type":"string","format":"uuid","nullable":true},"ParentGroupId":{"type":"string","format":"uuid","nullable":true},"SurveyFormId":{"type":"string","format":"uuid","nullable":true},"GroupStatusItemId":{"type":"string","format":"uuid","nullable":true},"AddNewUsersAutomatically":{"type":"boolean"},"AllowJoinGroupUsingLink":{"type":"boolean"},"AllowSelfSubscription":{"type":"boolean"},"GroupCategory":{"type":"string","nullable":true},"GroupCode":{"type":"string","nullable":true},"GroupDescription":{"type":"string","nullable":true},"GroupEmail":{"type":"string","nullable":true},"GroupFax":{"type":"string","nullable":true},"GroupImage":{"type":"string","nullable":true},"GroupIndustry":{"type":"string","nullable":true},"GroupIndustryComment":{"type":"string","nullable":true},"GroupLabel":{"type":"string","nullable":true},"GroupName":{"type":"string","nullable":true},"GroupOffice":{"type":"string","nullable":true},"GroupPhone":{"type":"string","nullable":true},"GroupRegion":{"type":"string","nullable":true},"GroupSize":{"type":"string","nullable":true},"GroupType":{"type":"string","nullable":true},"GroupWebSiteUrl":{"type":"string","nullable":true},"LastChangeType":{"type":"string","nullable":true},"LastChangeUser":{"type":"string","nullable":true},"LifetimeUnit":{"type":"string","nullable":true},"ShippingPreference":{"type":"string","nullable":true},"SocialMediaUrls":{"type":"string","nullable":true},"SurveyNecessity":{"type":"string","nullable":true},"GroupCapacity":{"type":"integer","format":"int32","nullable":true},"LifetimeQuantity":{"type":"integer","format":"int32","nullable":true},"GroupCreated":{"type":"string","format":"date-time"},"GroupExpiry":{"type":"string","format":"date-time","nullable":true},"LastChangeTime":{"type":"string","format":"date-time"}},"additionalProperties":false}}},"paths":{"/api/contacts/groups/collect":{"post":{"tags":["Contacts API: Groups"],"summary":"Collects the list of groups that match specific criteria","description":"Use LastChangeTimeSince and LastChangeTimeBefore to restrict the result set to groups modified within a\r\nspecific window. Both parameters accept ISO 8601 date-time values, for example \"2026-07-06T14:00:00+00:00\".\r\nLastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive.","operationId":"collectGroups","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CollectGroups"}},"application/json":{"schema":{"$ref":"#/components/schemas/CollectGroups"}},"text/json":{"schema":{"$ref":"#/components/schemas/CollectGroups"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CollectGroups"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupModel"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupModel"}}}}}}}}}}
```

## Counts the groups that match specific criteria

> 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.

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"CountGroups":{"type":"object","properties":{"GroupCode":{"type":"string","nullable":true},"GroupCreatedSince":{"type":"string","format":"date-time","nullable":true},"GroupCreatedBefore":{"type":"string","format":"date-time","nullable":true},"GroupExpirySince":{"type":"string","format":"date-time","nullable":true},"GroupExpiryBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"CountResult":{"type":"object","properties":{"Count":{"type":"integer","format":"int32"},"Summary":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/api/contacts/groups/count":{"post":{"tags":["Contacts API: Groups"],"summary":"Counts the groups that match specific criteria","description":"Use LastChangeTimeSince and LastChangeTimeBefore to restrict the count to groups modified within a\r\nspecific window. Both parameters accept ISO 8601 date-time values, for example \"2026-07-06T14:00:00+00:00\".\r\nLastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive.","operationId":"countGroups","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CountGroups"}},"application/json":{"schema":{"$ref":"#/components/schemas/CountGroups"}},"text/json":{"schema":{"$ref":"#/components/schemas/CountGroups"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CountGroups"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResult"}},"text/json":{"schema":{"$ref":"#/components/schemas/CountResult"}}}}}}}}}
```

## Downloads the list of groups that match specific criteria

> 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.

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"CollectGroups":{"type":"object","properties":{"GroupCode":{"type":"string","nullable":true},"GroupCreatedSince":{"type":"string","format":"date-time","nullable":true},"GroupCreatedBefore":{"type":"string","format":"date-time","nullable":true},"GroupExpirySince":{"type":"string","format":"date-time","nullable":true},"GroupExpiryBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}},"paths":{"/api/contacts/groups/download":{"post":{"tags":["Contacts API: Groups"],"summary":"Downloads the list of groups that match specific criteria","description":"Use LastChangeTimeSince and LastChangeTimeBefore to download only groups modified within a specific window,\r\nwhich is useful for incremental integrations that already hold most of the data. Both parameters accept\r\nISO 8601 date-time values, for example \"2026-07-06T14:00:00+00:00\". LastChangeTimeSince is inclusive;\r\nLastChangeTimeBefore is exclusive. When polling for deltas, subtract a small overlap (for example five\r\nminutes) from the previous poll time to allow for projection lag.","operationId":"downloadGroups","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CollectGroups"}},"application/json":{"schema":{"$ref":"#/components/schemas/CollectGroups"}},"text/json":{"schema":{"$ref":"#/components/schemas/CollectGroups"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CollectGroups"}}}},"responses":{"200":{"description":"OK"}}}}}}
```

## Searches for the list of groups that match specific criteria

> 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.

```json
{"openapi":"3.0.1","info":{"title":"Developer API","version":"v2.0.0"},"servers":[{"url":"/v2/e01"}],"security":[{"Bearer":[]},{"Cookie":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"-","name":"Bearer","in":"header"},"Cookie":{"type":"apiKey","description":"-","name":"InSite.WebToken","in":"cookie"}},"schemas":{"SearchGroups":{"type":"object","properties":{"GroupCode":{"type":"string","nullable":true},"GroupCreatedSince":{"type":"string","format":"date-time","nullable":true},"GroupCreatedBefore":{"type":"string","format":"date-time","nullable":true},"GroupExpirySince":{"type":"string","format":"date-time","nullable":true},"GroupExpiryBefore":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeSince":{"type":"string","format":"date-time","nullable":true},"LastChangeTimeBefore":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"GroupMatch":{"type":"object","properties":{"GroupId":{"type":"string","format":"uuid"},"GroupName":{"type":"string","nullable":true}},"additionalProperties":false}}},"paths":{"/api/contacts/groups/search":{"post":{"tags":["Contacts API: Groups"],"summary":"Searches for the list of groups that match specific criteria","description":"Use LastChangeTimeSince and LastChangeTimeBefore to restrict the result set to groups modified within a\r\nspecific window. Both parameters accept ISO 8601 date-time values, for example \"2026-07-06T14:00:00+00:00\".\r\nLastChangeTimeSince is inclusive; LastChangeTimeBefore is exclusive.","operationId":"searchGroups","requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/SearchGroups"}},"application/json":{"schema":{"$ref":"#/components/schemas/SearchGroups"}},"text/json":{"schema":{"$ref":"#/components/schemas/SearchGroups"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/SearchGroups"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupMatch"}}},"text/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GroupMatch"}}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.shiftiq.com/developers/api-v2/navigating-the-api/contacts-api-groups.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.