# 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":{"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":{"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"}}}}}}}}}
```

## POST /api/contacts/groups/collect

> Collects the list of groups that match specific criteria

```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":{"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","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"}}}}}}}}}}
```

## POST /api/contacts/groups/count

> Counts the groups that match specific criteria

```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":{"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","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"}}}}}}}}}
```

## POST /api/contacts/groups/download

> Downloads the list of groups that match specific criteria

```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":{"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","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"}}}}}}
```

## POST /api/contacts/groups/search

> Searches for the list of groups that match specific criteria

```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":{"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","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: 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:

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

The question should be specific, self-contained, and written in natural language.
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.