GrowthZone REST API API Reference
undefined
API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0
Paths
GET /api/groups/{groupid}
(no description)
OK
Response Example (200 OK)
{
"GroupId": "integer",
"AuditId": "integer",
"Name": "string",
"EmailRelayServiceAddress": "string",
"Actions": "string"
}
POST /api/groups/{groupid}/events
(no description)
OK
Response Example (200 OK)
[
{
"EventId": "integer",
"Name": "string",
"StartDate": "string",
"RegisteredAttendees": "integer",
"OrganizedBy": "string"
}
]
GET /api/groups/{groupid}/general
(no description)
OK
Response Example (200 OK)
{
"GroupId": "integer",
"AuditId": "integer",
"Name": "string",
"GroupTypeId": "string",
"GroupCategoryId": "string",
"EstablishedDate": "string",
"ShowWhenUnsubscribing": "boolean",
"Description": "string",
"SponsorContactId": "string",
"MeetingTimeDescription": "string",
"ContactName": "string",
"DefaultMonths": "string",
"IsActive": "boolean",
"AllowExternalIntegration": "boolean",
"DisallowOptOut": "boolean",
"AutoPopulateFromReportId": "string",
"ReportId": "string",
"IsPublicViewable": "boolean",
"IsPublicJoinable": "boolean",
"IsMemberViewable": "boolean",
"IsListMemberViewable": "boolean",
"IsMemberJoinable": "boolean",
"IsMemberEmailable": "boolean",
"SettingsJson": "string",
"Settings": "string"
}
Get list of members of group based on group id and paging
Takes in full Odata object. Example Request: /api/groups/1/members?skip=0&take=1&orderBy=ContactGroupId
The ID of the contact to return the fields from.
Options for filtering group results based using OData pattern.
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/groups/{groupid}/members
(no description)
Request Example
"object"
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/groups/{groupid}/members/{contactgroupid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"ContactGroupId": "integer",
"AuditId": "integer",
"ContactId": "integer",
"ContactDisplayName": "string",
"GroupId": "integer",
"ContactName": "string",
"Role": "string",
"EmailAddressId": "string",
"JoinDate": "string",
"DropDate": "string",
"IsActive": "boolean",
"DoNotContact": "boolean",
"DisplayOrder": "integer",
"DoNotContactEmail": "boolean",
"DoNotSendMassEmail": "boolean"
}
GET /api/groups/{groupid}/members/export
(no description)
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/groups/{groupid}/members/export/historical
(no description)
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/groups/{groupid}/members/search/
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"DisplayName": "string",
"SystemContactTypeId": "string",
"Name": "string",
"ContactDisplayName": "string",
"EmailAddress": "string",
"EmailAddressId": "string",
"PhoneNumber": "string",
"StateProvince": "string",
"City": "string",
"PhoneId": "string",
"WebAddress": "string",
"Image": "string",
"IsContact": "boolean",
"OriginalIsContact": "boolean",
"DestinationContactId": "integer",
"MembershipStatusTypeId": "string",
"Address1": "string",
"AddressString": "string"
}
]
GET /api/groups/{groupid}/members/typeahead
(no description)
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"ContactId": "integer",
"DisplayName": "string",
"SystemContactTypeId": "string",
"Name": "string",
"ContactDisplayName": "string",
"EmailAddress": "string",
"EmailAddressId": "string",
"PhoneNumber": "string",
"StateProvince": "string",
"City": "string",
"PhoneId": "string",
"WebAddress": "string",
"Image": "string",
"IsContact": "boolean",
"OriginalIsContact": "boolean",
"DestinationContactId": "integer",
"MembershipStatusTypeId": "string",
"Address1": "string",
"AddressString": "string"
}
]
GET /api/groups/all
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/groups/all
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"GroupCategoryId": "string",
"Criteria": "string",
"GroupTypeId": "string",
"ShowInactive": "boolean",
"ShowActive": "boolean"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/groups/categories
OK
Response Example (200 OK)
[
{
"GroupCategoryId": "integer",
"Name": "string",
"GroupTypeId": "string",
"Description": "string"
}
]
GET /api/groups/categories/{groupcategoryid}
(no description)
OK
Response Example (200 OK)
{
"GroupCategoryId": "integer",
"AuditId": "integer",
"GroupTypeId": "string",
"Name": "string",
"Description": "string"
}
GET /api/groups/categories/lookup/{grouptypeid}
(no description)
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/groups/categories/lookup/marketing
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/groups/contactgroups/{contactgroupid}/edit
(no description)
OK
Response Example (200 OK)
{
"GroupId": "integer",
"ContactId": "integer",
"ContactGroupId": "integer",
"AuditId": "integer",
"ContactDisplayName": "string",
"Role": "string",
"EmailAddressId": "string",
"DoNotContact": "boolean",
"DropDate": "string"
}
GET /api/groups/emaillists/committee
OK
Response Example (200 OK)
{
"GroupId": "integer",
"AuditId": "integer",
"Name": "string",
"GroupTypeId": "string",
"GroupCategoryId": "string",
"EstablishedDate": "string",
"ShowWhenUnsubscribing": "boolean",
"Description": "string",
"SponsorContactId": "string",
"MeetingTimeDescription": "string",
"ContactName": "string",
"DefaultMonths": "string",
"IsActive": "boolean",
"AllowExternalIntegration": "boolean",
"DisallowOptOut": "boolean",
"IsMemberEmailable": "boolean",
"IsPublicViewable": "boolean",
"IsPublicJoinable": "boolean",
"IsMemberViewable": "boolean",
"IsMemberJoinable": "boolean",
"IsListMemberViewable": "boolean",
"ExternalIdentifiersJson": "string"
}
GET /api/groups/emaillists/email
OK
Response Example (200 OK)
{
"GroupId": "integer",
"AuditId": "integer",
"Name": "string",
"GroupTypeId": "string",
"GroupCategoryId": "string",
"EstablishedDate": "string",
"ShowWhenUnsubscribing": "boolean",
"Description": "string",
"IsActive": "boolean",
"IsPublicJoinable": "boolean",
"IsMemberJoinable": "boolean",
"AllowExternalIntegration": "boolean"
}
GET /api/groups/emaillists/interestgroup
OK
Response Example (200 OK)
{
"GroupId": "integer",
"AuditId": "integer",
"Name": "string",
"GroupTypeId": "string",
"GroupCategoryId": "string",
"EstablishedDate": "string",
"ShowWhenUnsubscribing": "boolean",
"Description": "string",
"IsActive": "boolean",
"IsPublicJoinable": "boolean",
"IsMemberJoinable": "boolean",
"AllowExternalIntegration": "boolean"
}
GET /api/groups/lookup
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
]
GET /api/groups/lookup/active
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
]
GET /api/groups/lookup/available/contact
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
]
GET /api/groups/lookup/chapter
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
]
GET /api/groups/lookup/emaillist
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
]
GET /api/groups/lookup/marketingautomation
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
]
GET /api/groups/lookup/member
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
]
GET /api/groups/lookup/own
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
]
GET /api/groups/lookup/public
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
]
GET /api/groups/lookup/publicandmember
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
]
GET /api/groups/lookup/staff
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
]
GET /api/groups/stats/{groupid}
(no description)
OK
Response Example (200 OK)
{
"GroupId": "integer",
"CurrentUsers": "string"
}
Schema Definitions
ListViewReturnModel<GroupCollectionItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GroupAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- GroupCategoryId: string
- Criteria: string
- GroupTypeId: string
- ShowInactive: boolean
- ShowActive: boolean
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"GroupCategoryId": "string",
"Criteria": "string",
"GroupTypeId": "string",
"ShowInactive": "boolean",
"ShowActive": "boolean"
}
GroupListStatusReportModel: object
- GroupId: integer
- CurrentUsers: string
Example
{
"GroupId": "integer",
"CurrentUsers": "string"
}
GroupBaseModel: object
- GroupId: integer
- AuditId: integer
- Name: string
- EmailRelayServiceAddress: string
- Actions: string
Example
{
"GroupId": "integer",
"AuditId": "integer",
"Name": "string",
"EmailRelayServiceAddress": "string",
"Actions": "string"
}
EmailListAddEditModel: object
- GroupId: integer
- AuditId: integer
- Name: string
- GroupTypeId: string
- GroupCategoryId: string
- EstablishedDate: string
- ShowWhenUnsubscribing: boolean
- Description: string
- IsActive: boolean
- IsPublicJoinable: boolean
- IsMemberJoinable: boolean
- AllowExternalIntegration: boolean
Example
{
"GroupId": "integer",
"AuditId": "integer",
"Name": "string",
"GroupTypeId": "string",
"GroupCategoryId": "string",
"EstablishedDate": "string",
"ShowWhenUnsubscribing": "boolean",
"Description": "string",
"IsActive": "boolean",
"IsPublicJoinable": "boolean",
"IsMemberJoinable": "boolean",
"AllowExternalIntegration": "boolean"
}
CommitteeAddEditModel: object
- GroupId: integer
- AuditId: integer
- Name: string
- GroupTypeId: string
- GroupCategoryId: string
- EstablishedDate: string
- ShowWhenUnsubscribing: boolean
- Description: string
- SponsorContactId: string
- MeetingTimeDescription: string
- ContactName: string
- DefaultMonths: string
- IsActive: boolean
- AllowExternalIntegration: boolean
- DisallowOptOut: boolean
- IsMemberEmailable: boolean
- IsPublicViewable: boolean
- IsPublicJoinable: boolean
- IsMemberViewable: boolean
- IsMemberJoinable: boolean
- IsListMemberViewable: boolean
- ExternalIdentifiersJson: string
Example
{
"GroupId": "integer",
"AuditId": "integer",
"Name": "string",
"GroupTypeId": "string",
"GroupCategoryId": "string",
"EstablishedDate": "string",
"ShowWhenUnsubscribing": "boolean",
"Description": "string",
"SponsorContactId": "string",
"MeetingTimeDescription": "string",
"ContactName": "string",
"DefaultMonths": "string",
"IsActive": "boolean",
"AllowExternalIntegration": "boolean",
"DisallowOptOut": "boolean",
"IsMemberEmailable": "boolean",
"IsPublicViewable": "boolean",
"IsPublicJoinable": "boolean",
"IsMemberViewable": "boolean",
"IsMemberJoinable": "boolean",
"IsListMemberViewable": "boolean",
"ExternalIdentifiersJson": "string"
}
InterestGroupAddEditModel: object
- GroupId: integer
- AuditId: integer
- Name: string
- GroupTypeId: string
- GroupCategoryId: string
- EstablishedDate: string
- ShowWhenUnsubscribing: boolean
- Description: string
- IsActive: boolean
- IsPublicJoinable: boolean
- IsMemberJoinable: boolean
- AllowExternalIntegration: boolean
Example
{
"GroupId": "integer",
"AuditId": "integer",
"Name": "string",
"GroupTypeId": "string",
"GroupCategoryId": "string",
"EstablishedDate": "string",
"ShowWhenUnsubscribing": "boolean",
"Description": "string",
"IsActive": "boolean",
"IsPublicJoinable": "boolean",
"IsMemberJoinable": "boolean",
"AllowExternalIntegration": "boolean"
}
AdvancedGroupGeneralModel: object
- GroupId: integer
- AuditId: integer
- Name: string
- GroupTypeId: string
- GroupCategoryId: string
- EstablishedDate: string
- ShowWhenUnsubscribing: boolean
- Description: string
- SponsorContactId: string
- MeetingTimeDescription: string
- ContactName: string
- DefaultMonths: string
- IsActive: boolean
- AllowExternalIntegration: boolean
- DisallowOptOut: boolean
- AutoPopulateFromReportId: string
- ReportId: string
- IsPublicViewable: boolean
- IsPublicJoinable: boolean
- IsMemberViewable: boolean
- IsListMemberViewable: boolean
- IsMemberJoinable: boolean
- IsMemberEmailable: boolean
- SettingsJson: string
- Settings: string
Example
{
"GroupId": "integer",
"AuditId": "integer",
"Name": "string",
"GroupTypeId": "string",
"GroupCategoryId": "string",
"EstablishedDate": "string",
"ShowWhenUnsubscribing": "boolean",
"Description": "string",
"SponsorContactId": "string",
"MeetingTimeDescription": "string",
"ContactName": "string",
"DefaultMonths": "string",
"IsActive": "boolean",
"AllowExternalIntegration": "boolean",
"DisallowOptOut": "boolean",
"AutoPopulateFromReportId": "string",
"ReportId": "string",
"IsPublicViewable": "boolean",
"IsPublicJoinable": "boolean",
"IsMemberViewable": "boolean",
"IsListMemberViewable": "boolean",
"IsMemberJoinable": "boolean",
"IsMemberEmailable": "boolean",
"SettingsJson": "string",
"Settings": "string"
}
ListViewReturnModel<GroupMemberCollectionItemModel>: object
- Criteria: string
- CriteriaItems: string
- TotalRecordAvailable: string
-
We typically only return a subset of what is available on the server, but lets show the user what was available
- ModelItems: string
- Results: string
Example
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GroupMemberAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- GroupId: integer
- Criteria: string
- IncludeHistoricalContacts: boolean
- IncludePublicSubscriptions: boolean
- Status: string
- ContactIds: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"GroupId": "integer",
"Criteria": "string",
"IncludeHistoricalContacts": "boolean",
"IncludePublicSubscriptions": "boolean",
"Status": "string",
"ContactIds": "string"
}
HttpResponseMessage: object
- Version: string
- Content: string
- StatusCode: string
- ReasonPhrase: string
- Headers: string
- RequestMessage: string
- IsSuccessStatusCode: boolean
Example
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GroupEventCollectionItemModel: object
- EventId: integer
- Name: string
- StartDate: string
- RegisteredAttendees: integer
- OrganizedBy: string
Example
{
"EventId": "integer",
"Name": "string",
"StartDate": "string",
"RegisteredAttendees": "integer",
"OrganizedBy": "string"
}
GroupChoiceModel: object
- Id: integer
- Name: string
- IsSelected: boolean
- GroupId: integer
- AuditId: integer
- GroupCategoryId: integer
- GroupCategoryName: string
- Description: string
Example
{
"Id": "integer",
"Name": "string",
"IsSelected": "boolean",
"GroupId": "integer",
"AuditId": "integer",
"GroupCategoryId": "integer",
"GroupCategoryName": "string",
"Description": "string"
}
GroupTagEntryItem: object
- GroupId: integer
- Name: string
Example
{
"GroupId": "integer",
"Name": "string"
}
GroupMemberAddEditModel: object
- ContactGroupId: integer
- AuditId: integer
- ContactId: integer
- ContactDisplayName: string
- GroupId: integer
- ContactName: string
- Role: string
- EmailAddressId: string
- JoinDate: string
- DropDate: string
- IsActive: boolean
- DoNotContact: boolean
- DisplayOrder: integer
- DoNotContactEmail: boolean
- DoNotSendMassEmail: boolean
Example
{
"ContactGroupId": "integer",
"AuditId": "integer",
"ContactId": "integer",
"ContactDisplayName": "string",
"GroupId": "integer",
"ContactName": "string",
"Role": "string",
"EmailAddressId": "string",
"JoinDate": "string",
"DropDate": "string",
"IsActive": "boolean",
"DoNotContact": "boolean",
"DisplayOrder": "integer",
"DoNotContactEmail": "boolean",
"DoNotSendMassEmail": "boolean"
}
ContactGroupEditModel: object
- GroupId: integer
- ContactId: integer
- ContactGroupId: integer
- AuditId: integer
- ContactDisplayName: string
- Role: string
- EmailAddressId: string
- DoNotContact: boolean
- DropDate: string
Example
{
"GroupId": "integer",
"ContactId": "integer",
"ContactGroupId": "integer",
"AuditId": "integer",
"ContactDisplayName": "string",
"Role": "string",
"EmailAddressId": "string",
"DoNotContact": "boolean",
"DropDate": "string"
}
ContactTypeAheadItem: object
- ContactId: integer
- DisplayName: string
- SystemContactTypeId: string
- Name: string
- ContactDisplayName: string
- EmailAddress: string
- EmailAddressId: string
- PhoneNumber: string
- StateProvince: string
- City: string
- PhoneId: string
- WebAddress: string
- Image: string
- IsContact: boolean
- OriginalIsContact: boolean
- DestinationContactId: integer
-
For contact merging
- MembershipStatusTypeId: string
- Address1: string
- AddressString: string
Example
{
"ContactId": "integer",
"DisplayName": "string",
"SystemContactTypeId": "string",
"Name": "string",
"ContactDisplayName": "string",
"EmailAddress": "string",
"EmailAddressId": "string",
"PhoneNumber": "string",
"StateProvince": "string",
"City": "string",
"PhoneId": "string",
"WebAddress": "string",
"Image": "string",
"IsContact": "boolean",
"OriginalIsContact": "boolean",
"DestinationContactId": "integer",
"MembershipStatusTypeId": "string",
"Address1": "string",
"AddressString": "string"
}
AddEditGroupCategoryModel: object
- GroupCategoryId: integer
- AuditId: integer
- GroupTypeId: string
- Name: string
- Description: string
Example
{
"GroupCategoryId": "integer",
"AuditId": "integer",
"GroupTypeId": "string",
"Name": "string",
"Description": "string"
}
GroupCategoryCollectionItemModel: object
- GroupCategoryId: integer
- Name: string
- GroupTypeId: string
- Description: string
Example
{
"GroupCategoryId": "integer",
"Name": "string",
"GroupTypeId": "string",
"Description": "string"
}
GenericLookUpChoice<Int32>: object
- Id: integer
- Name: string
- ExtraData: string
- CssColor: string
- IsSelected: boolean
- IsDeleted: boolean
- Order: integer
Example
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}