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

ContactOverview

GET /api/contactoverview/{contactid}

contactid: integer
in query

(no description)

200 OK
ContactOverviewModel

OK

Response Example (200 OK) 
{
  "ScrollTo": "string",
  "ContactId": "integer",
  "ContactOrganizationId": "integer",
  "PersonContactId": "integer",
  "SystemContactTypeId": "string",
  "CategoryTypeId": "string",
  "IsContactChaptersReadOnly": "boolean",
  "ContactDisplayName": "string",
  "FamilyContactsEnabled": "boolean",
  "IsMembershipOwner": "boolean",
  "Widgets": "string"
}
ContactOverview

GET /api/contactoverview/{contactid}/activitiestablewidget

contactid: integer
in query

(no description)

200 OK
ActivitiesTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/assignedstaff

contactid: integer
in query

(no description)

200 OK
AssignedStaffTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/benefitsummary

BenefitAssignmentsAdvancedFilter

undefined

contactid: integer
in query

(no description)

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "HasBenefits": "boolean",
  "DoesNotHaveBenefits": "boolean",
  "HasRemainingBenefits": "boolean",
  "HasUsedBenefits": "boolean",
  "ContactBenefitStatusId": "string",
  "BenefitItemId": "string",
  "BenefitType": "string",
  "CategoryId": "string",
  "StatusTypeOptions": "string",
  "MembershipTypeId": "string",
  "UsageRangeQuickOptions": "string",
  "UsedDateRange": "string",
  "Criteria": "string"
}
200 OK
BenefitSummaryTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/billingbalance

contactid: integer
in query

(no description)

200 OK
QuickLookData

OK

Response Example (200 OK) 
{
  "Value": "string",
  "Heading": "string",
  "SubHeading": "string",
  "Action": "string"
}
ContactOverview

GET /api/contactoverview/{contactid}/billingnotes

contactid: integer
in query

(no description)

200 OK
QuickLookData

OK

Response Example (200 OK) 
{
  "Value": "string",
  "Heading": "string",
  "SubHeading": "string",
  "Action": "string"
}
ContactOverview

GET /api/contactoverview/{contactid}/categories

contactid: integer
in query

(no description)

200 OK
CategoriesTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/certifications

contactid: integer
in query

(no description)

200 OK
CertificationsTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/chapters

contactid: integer
in query

(no description)

200 OK
ChaptersTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/communications

contactid: integer
in query

(no description)

200 OK
CommunicationsTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/contactexperiences

contactid: integer
in query

(no description)

200 OK
ContactExperienceTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/contactinfo

contactid: integer
in query

(no description)

200 OK
ContactInfoKeyValueData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string"
}
ContactOverview

GET /api/contactoverview/{contactid}/contactorgs

contactid: integer
in query

(no description)

200 OK
IndividualOrgsTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/contacttags

contactid: integer
in query

(no description)

200 OK
ContactTagData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string"
}
ContactOverview

GET /api/contactoverview/{contactid}/directories

contactid: integer
in query

(no description)

200 OK
DirectoriesTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/formssurveys

contactid: integer
in query

(no description)

200 OK
FormsSurveysTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/fundraisingactivities

contactid: integer
in query

(no description)

200 OK
FundraisingActivityTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/groups

contactid: integer
in query

(no description)

200 OK
ListsAndCommitteesTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/individualfamilies

contactid: integer
in query

(no description)

200 OK
IndividualFamiliesTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/memberships

contactid: integer
in query

(no description)

200 OK
MembershipsTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/orgcontacts

contactid: integer
in query

(no description)

200 OK
OrgIndividualsTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/paymentprofile

contactid: integer
in query

(no description)

200 OK
QuickLookData

OK

Response Example (200 OK) 
{
  "Value": "string",
  "Heading": "string",
  "SubHeading": "string",
  "Action": "string"
}
ContactOverview

GET /api/contactoverview/{contactid}/projects

contactid: integer
in query

(no description)

200 OK
ProjectsTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/relatedchildorgs

contactid: integer
in query

(no description)

200 OK
RelatedOrgTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/relatedcontacts

contactid: integer
in query

(no description)

200 OK
RelatedContactsTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/relatedparentorgs

contactid: integer
in query

(no description)

200 OK
RelatedOrgTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/salesopportunities

contactid: integer
in query

(no description)

200 OK
SalesOpportunityTableData

OK

Response Example (200 OK) 
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}
ContactOverview

GET /api/contactoverview/{contactid}/scheduledbilling

contactid: integer
in query

(no description)

200 OK
QuickLookData

OK

Response Example (200 OK) 
{
  "Value": "string",
  "Heading": "string",
  "SubHeading": "string",
  "Action": "string"
}
ContactOverview

GET /api/contactoverview/{contactid}/taxset

contactid: integer
in query

(no description)

200 OK
QuickLookData

OK

Response Example (200 OK) 
{
  "Value": "string",
  "Heading": "string",
  "SubHeading": "string",
  "Action": "string"
}

Schema Definitions

ContactOverviewModel: object

ScrollTo: string
ContactId: integer
ContactOrganizationId: integer
PersonContactId: integer
SystemContactTypeId: string
CategoryTypeId: string
IsContactChaptersReadOnly: boolean
ContactDisplayName: string
FamilyContactsEnabled: boolean
IsMembershipOwner: boolean
Widgets: string
Example
{
  "ScrollTo": "string",
  "ContactId": "integer",
  "ContactOrganizationId": "integer",
  "PersonContactId": "integer",
  "SystemContactTypeId": "string",
  "CategoryTypeId": "string",
  "IsContactChaptersReadOnly": "boolean",
  "ContactDisplayName": "string",
  "FamilyContactsEnabled": "boolean",
  "IsMembershipOwner": "boolean",
  "Widgets": "string"
}

ProjectsTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

SalesOpportunityTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

ContactInfoKeyValueData: object

ModelType: string
Items: string
TotalRecordAvailable: string
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string"
}

RelatedContactsTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

ListsAndCommitteesTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

QuickLookData: object

Value: string
Heading: string
SubHeading: string
Action: string
Example
{
  "Value": "string",
  "Heading": "string",
  "SubHeading": "string",
  "Action": "string"
}

AssignedStaffTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

CommunicationsTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

CategoriesTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

MembershipsTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

DirectoriesTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

ChaptersTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

IndividualOrgsTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

IndividualFamiliesTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

OrgIndividualsTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

RelatedOrgTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

BenefitSummaryTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

BenefitAssignmentsAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
HasBenefits: boolean
DoesNotHaveBenefits: boolean
HasRemainingBenefits: boolean
HasUsedBenefits: boolean
ContactBenefitStatusId: string
BenefitItemId: string
BenefitType: string
CategoryId: string
StatusTypeOptions: string
MembershipTypeId: string
UsageRangeQuickOptions: string
UsedDateRange: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "HasBenefits": "boolean",
  "DoesNotHaveBenefits": "boolean",
  "HasRemainingBenefits": "boolean",
  "HasUsedBenefits": "boolean",
  "ContactBenefitStatusId": "string",
  "BenefitItemId": "string",
  "BenefitType": "string",
  "CategoryId": "string",
  "StatusTypeOptions": "string",
  "MembershipTypeId": "string",
  "UsageRangeQuickOptions": "string",
  "UsedDateRange": "string",
  "Criteria": "string"
}

CertificationsTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

FundraisingActivityTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

ContactExperienceTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

ActivitiesTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

FormsSurveysTableData: object

ModelType: string
Items: string
TotalRecordAvailable: string
HideShowMore: boolean
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string",
  "HideShowMore": "boolean"
}

ContactTagData: object

ModelType: string
Items: string
TotalRecordAvailable: string
Example
{
  "ModelType": "string",
  "Items": "string",
  "TotalRecordAvailable": "string"
}
Documentation by Spectacle