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/tenants/{tenantid}/add
(no description)
OK
Response Example (200 OK)
{
"TenantId": "integer",
"UserHostAddress": "string",
"UserAgent": "string",
"ContactId": "integer",
"ContactName": "string",
"ProductId": "string",
"MembershipTypeId": "string",
"EndDate": "string",
"IsActive": "boolean",
"IsTrial": "boolean",
"ForInternalUse": "boolean",
"OnboardingStartDate": "string",
"OnboardingEndDate": "string",
"SendLoginInformation": "boolean",
"CustomFields": "string"
}
POST /api/tenants/{tenantid}/add
undefined
(no description)
Request Example
{
"TenantId": "integer",
"UserHostAddress": "string",
"UserAgent": "string",
"ContactId": "integer",
"ContactName": "string",
"ProductId": "string",
"MembershipTypeId": "string",
"EndDate": "string",
"IsActive": "boolean",
"IsTrial": "boolean",
"ForInternalUse": "boolean",
"OnboardingStartDate": "string",
"OnboardingEndDate": "string",
"SendLoginInformation": "boolean",
"CustomFields": "string"
}
OK
Response Example (200 OK)
{
"GlobalKey": "string",
"TenantUrl": "string",
"TenantId": "integer",
"Name": "string",
"CreateDate": "string",
"UserVoiceURL": "string",
"UserVoice": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"EditionId": "string",
"EditionName": "string",
"IsSandboxAccount": "boolean",
"HideDisableTenant": "boolean",
"HideEnableTenant": "boolean",
"HideDeleteTenant": "boolean",
"HideTenantSandboxEnable": "boolean",
"HideTenantSandboxDisable": "boolean",
"MasterKey": "string",
"TotalRecordAvailable": "integer",
"Actions": "string"
}
GET /api/tenants/{tenantid}/edit
(no description)
OK
Response Example (200 OK)
{
"TenantId": "integer",
"TenantKey": "string",
"Name": "string",
"EditionId": "string",
"ProductId": "string",
"IsActive": "boolean",
"IsDemo": "boolean",
"IsInternalTenant": "boolean",
"OnboardingStartDate": "string",
"OnboardingEndDate": "string",
"ConversionTypeId": "string",
"EmailPool": "string",
"Modules": "string"
}
POST /api/tenants/{tenantid}/edit
undefined
(no description)
Request Example
{
"TenantId": "integer",
"TenantKey": "string",
"Name": "string",
"EditionId": "string",
"ProductId": "string",
"IsActive": "boolean",
"IsDemo": "boolean",
"IsInternalTenant": "boolean",
"OnboardingStartDate": "string",
"OnboardingEndDate": "string",
"ConversionTypeId": "string",
"EmailPool": "string",
"Modules": "string"
}
OK
Response Example (200 OK)
{
"GlobalKey": "string",
"TenantUrl": "string",
"TenantId": "integer",
"Name": "string",
"CreateDate": "string",
"UserVoiceURL": "string",
"UserVoice": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"EditionId": "string",
"EditionName": "string",
"IsSandboxAccount": "boolean",
"HideDisableTenant": "boolean",
"HideEnableTenant": "boolean",
"HideDeleteTenant": "boolean",
"HideTenantSandboxEnable": "boolean",
"HideTenantSandboxDisable": "boolean",
"MasterKey": "string",
"TotalRecordAvailable": "integer",
"Actions": "string"
}
POST /api/tenants/{tenantid}/membership
undefined
(no description)
Request Example
{
"GlobalKey": "string",
"TenantId": "integer",
"Name": "string",
"TenantMembershipType": "string",
"Membership": "string",
"MembershipId": "string",
"OrganizationContactId": "string",
"OrganizationName": "string",
"MembershipTypeId": "string",
"EndDate": "string"
}
OK
Response Example (200 OK)
{
"GlobalKey": "string",
"TenantId": "integer",
"Name": "string",
"CreateDate": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"EditionName": "string"
}
GET /api/tenants/{tenantid}/view
(no description)
OK
Response Example (200 OK)
{
"TenantId": "integer",
"ContactsCount": "integer",
"OrgCount": "integer",
"PersonCount": "integer",
"StaffCount": "integer"
}
GET /api/tenants/all
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/tenants/all
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"EditionId": "string",
"CreateDateRange": "string",
"ContactsCountRange": "string",
"NoLoginSince": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"Criteria": "string",
"HideDeletingTenants": "boolean"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/tenants/all/integrationtestfilter
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"EditionId": "string",
"CreateDateRange": "string",
"ContactsCountRange": "string",
"NoLoginSince": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"Criteria": "string",
"HideDeletingTenants": "boolean"
}
OK
Response Example (200 OK)
[
{
"GlobalKey": "string",
"TenantUrl": "string",
"TenantId": "integer",
"Name": "string",
"CreateDate": "string",
"UserVoiceURL": "string",
"UserVoice": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"EditionId": "string",
"EditionName": "string",
"IsSandboxAccount": "boolean",
"HideDisableTenant": "boolean",
"HideEnableTenant": "boolean",
"HideDeleteTenant": "boolean",
"HideTenantSandboxEnable": "boolean",
"HideTenantSandboxDisable": "boolean",
"MasterKey": "string",
"TotalRecordAvailable": "integer",
"Actions": "string"
}
]
GET /api/tenants/chapteraffiliate/typeahead
(no description)
(no description)
OK
Response Example (200 OK)
[
{
"TenantId": "string",
"Name": "string",
"TenantKey": "string"
}
]
GET /api/tenants/currentusers
OK
Response Example (200 OK)
[
{
"ConnectionId": "string",
"TenantKey": "string",
"LoginId": "integer",
"Customer": "string",
"User": "string",
"OnSince": "string",
"ServerName": "string"
}
]
Method works on cleaing out all data for a given tenant
The masterkey is hardcoded for now. Note this masterkey is also used in ContactsApiController.GetActivationToken. Currently only allow Lisa Barnett, Peter Saeger, Clara Navin, Jill Haugene.
Tenant key we are going to delete
Tenant Id we are going to delete
Extra auth data for the deletion
OK
POST /api/tenants/disable/{globalkey}/{tenantid}
(no description)
(no description)
OK
POST /api/tenants/enable/{globalkey}/{tenantid}
(no description)
(no description)
OK
GET /api/tenants/exists/{tenantkey}
(no description)
OK
GET /api/tenants/lookup
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"Key": "string"
}
]
GET /api/tenants/lookup/logintenant/{loginid}
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/tenants/lookup/logintenant/username/{search}
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/tenants/modules/lookup
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
POST /api/tenants/release
undefined
Request Example
{
"AppVersionHistoryId": "integer",
"IsEditable": "boolean",
"DeploymentDate": "string",
"Version": "string",
"Summary": "string",
"Description": "string",
"Changes": "string"
}
OK
Response Example (200 OK)
{
"AppVersionHistoryId": "integer",
"DeploymentDate": "string",
"Version": "string",
"Summary": "string"
}
GET /api/tenants/release/{appversionhistoryid}
(no description)
OK
Response Example (200 OK)
{
"AppVersionHistoryId": "integer",
"IsEditable": "boolean",
"DeploymentDate": "string",
"Version": "string",
"Summary": "string",
"Description": "string",
"Changes": "string"
}
GET /api/tenants/releases
OK
Response Example (200 OK)
{
"Releases": "string"
}
POST /api/tenants/sandbox/disable/{globalkey}/{tenantid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"GlobalKey": "string",
"TenantUrl": "string",
"TenantId": "integer",
"Name": "string",
"CreateDate": "string",
"UserVoiceURL": "string",
"UserVoice": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"EditionId": "string",
"EditionName": "string",
"IsSandboxAccount": "boolean",
"HideDisableTenant": "boolean",
"HideEnableTenant": "boolean",
"HideDeleteTenant": "boolean",
"HideTenantSandboxEnable": "boolean",
"HideTenantSandboxDisable": "boolean",
"MasterKey": "string",
"TotalRecordAvailable": "integer",
"Actions": "string"
}
POST /api/tenants/sandbox/enable/{globalkey}/{tenantid}
(no description)
(no description)
OK
Response Example (200 OK)
{
"GlobalKey": "string",
"TenantUrl": "string",
"TenantId": "integer",
"Name": "string",
"CreateDate": "string",
"UserVoiceURL": "string",
"UserVoice": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"EditionId": "string",
"EditionName": "string",
"IsSandboxAccount": "boolean",
"HideDisableTenant": "boolean",
"HideEnableTenant": "boolean",
"HideDeleteTenant": "boolean",
"HideTenantSandboxEnable": "boolean",
"HideTenantSandboxDisable": "boolean",
"MasterKey": "string",
"TotalRecordAvailable": "integer",
"Actions": "string"
}
GET /api/tenants/searchindex/{searchindexid}
(no description)
OK
Response Example (200 OK)
{
"SearchIndexId": "integer",
"IndexName": "string",
"LastSyncDate": "string",
"DocumentCount": "integer",
"DocumentPercentage": "string",
"StorageSize": "integer",
"StoragePercentage": "string"
}
GET /api/tenants/searchindex/all
OK
Response Example (200 OK)
[
{
"SearchIndexSyncInfoId": "integer",
"IndexName": "string",
"SearchIndexTypeId": "string",
"Name": "string",
"LastSyncDate": "string",
"DatabaseDocumentCount": "string",
"IndexDocumentCount": "string",
"AuditSourceId": "string",
"Actions": "string"
}
]
GET /api/tenants/searchindex/clear/{globalkey}/{tenantid}
(no description)
(no description)
OK
POST /api/tenants/searchindex/createbetaindices
OK
POST /api/tenants/searchindex/removedeleteditems
OK
POST /api/tenants/searchindex/removeindices
OK
GET /api/tenants/searchindex/reset/{tenantid}
(no description)
OK
POST /api/tenants/searchindex/runnow
OK
POST /api/tenants/searchindex/switchindex
OK
GET /api/tenants/switchaccount/{loginid}
(no description)
OK
Response Example (200 OK)
{
"LoginId": "integer",
"DefaultTenantId": "integer",
"DefaultTenantKey": "string"
}
POST /api/tenants/switchaccount/{loginid}
undefined
(no description)
Request Example
{
"LoginId": "integer",
"DefaultTenantId": "integer",
"DefaultTenantKey": "string"
}
OK
Response Example (200 OK)
{
"RedirectToUrl": "string",
"PostActions": "string"
}
GET /api/tenants/tenantlastlogin
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/tenants/tenantlastlogin
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"EditionId": "string",
"CreateDateRange": "string",
"ContactsCountRange": "string",
"NoLoginSince": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"Criteria": "string",
"HideDeletingTenants": "boolean"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/tenants/tenantusers
OK
Response Example (200 OK)
{
"Users": "string"
}
Created dummy payment profiles for stripe could be extended to do multiple payment gateway types, but Stripe is what we're testing with currently.
Created dummy payment profiles for stripe could be extended to do multiple payment gateway types, but Stripe is what we're testing with currently.
OK
Creates a stripe payment gateway and sets it as default for the tenant, for testing purposes. could be extended to do multiple payment gateway types, but Stripe is what we're testing with currently.
Creates a stripe payment gateway and sets it as default for the tenant, for testing purposes. could be extended to do multiple payment gateway types, but Stripe is what we're testing with currently.
OK
POST /api/tenants/triggerwebhookforall
OK
GET /api/tenants/triggerwebhookforlist
OK
Response Example (200 OK)
{
"JSON": "string"
}
POST /api/tenants/triggerwebhookforlist
undefined
Request Example
{
"JSON": "string"
}
OK
GET /api/tenants/unmatch
OK
Response Example (200 OK)
[
{
"GlobalKey": "string",
"TenantId": "integer",
"Name": "string",
"CreateDate": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"EditionName": "string"
}
]
Schema Definitions
ListViewReturnModel<TenantCollectionItemModel>: 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"
}
TenantAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- EditionId: string
- CreateDateRange: string
- ContactsCountRange: string
- NoLoginSince: string
- IsDemo: boolean
- IsActive: boolean
- Criteria: string
- HideDeletingTenants: boolean
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"EditionId": "string",
"CreateDateRange": "string",
"ContactsCountRange": "string",
"NoLoginSince": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"Criteria": "string",
"HideDeletingTenants": "boolean"
}
TenantCollectionItemModel: object
- GlobalKey: string
- TenantUrl: string
- TenantId: integer
- Name: string
- CreateDate: string
- UserVoiceURL: string
- UserVoice: string
- IsDemo: boolean
- IsActive: boolean
- EditionId: string
- EditionName: string
- IsSandboxAccount: boolean
- HideDisableTenant: boolean
- HideEnableTenant: boolean
- HideDeleteTenant: boolean
- HideTenantSandboxEnable: boolean
- HideTenantSandboxDisable: boolean
- MasterKey: string
- TotalRecordAvailable: integer
- Actions: string
Example
{
"GlobalKey": "string",
"TenantUrl": "string",
"TenantId": "integer",
"Name": "string",
"CreateDate": "string",
"UserVoiceURL": "string",
"UserVoice": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"EditionId": "string",
"EditionName": "string",
"IsSandboxAccount": "boolean",
"HideDisableTenant": "boolean",
"HideEnableTenant": "boolean",
"HideDeleteTenant": "boolean",
"HideTenantSandboxEnable": "boolean",
"HideTenantSandboxDisable": "boolean",
"MasterKey": "string",
"TotalRecordAvailable": "integer",
"Actions": "string"
}
IntegrationTestTenantFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- EditionId: string
- CreateDateRange: string
- ContactsCountRange: string
- NoLoginSince: string
- IsDemo: boolean
- IsActive: boolean
- Criteria: string
- HideDeletingTenants: boolean
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"EditionId": "string",
"CreateDateRange": "string",
"ContactsCountRange": "string",
"NoLoginSince": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"Criteria": "string",
"HideDeletingTenants": "boolean"
}
TenantUnmatchListItemModel: object
- GlobalKey: string
- TenantId: integer
- Name: string
- CreateDate: string
- IsDemo: boolean
- IsActive: boolean
- EditionName: string
Example
{
"GlobalKey": "string",
"TenantId": "integer",
"Name": "string",
"CreateDate": "string",
"IsDemo": "boolean",
"IsActive": "boolean",
"EditionName": "string"
}
TenantLookupChoiceModel: object
- Id: integer
- Name: string
- Key: string
Example
{
"Id": "integer",
"Name": "string",
"Key": "string"
}
IQueryable: object
- Expression: string
- ElementType: string
- Provider: string
Example
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
AdminCurrentUsers: object
- ConnectionId: string
- TenantKey: string
- LoginId: integer
- Customer: string
- User: string
- OnSince: string
- ServerName: string
Example
{
"ConnectionId": "string",
"TenantKey": "string",
"LoginId": "integer",
"Customer": "string",
"User": "string",
"OnSince": "string",
"ServerName": "string"
}
ListViewReturnModel<TenantLastLoginListItemModel>: 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"
}
SearchIndexCollectionItemModel: object
- SearchIndexSyncInfoId: integer
- IndexName: string
- SearchIndexTypeId: string
- Name: string
- LastSyncDate: string
- DatabaseDocumentCount: string
- IndexDocumentCount: string
- AuditSourceId: string
- Actions: string
Example
{
"SearchIndexSyncInfoId": "integer",
"IndexName": "string",
"SearchIndexTypeId": "string",
"Name": "string",
"LastSyncDate": "string",
"DatabaseDocumentCount": "string",
"IndexDocumentCount": "string",
"AuditSourceId": "string",
"Actions": "string"
}
SearchIndexModel: object
- SearchIndexId: integer
- IndexName: string
- LastSyncDate: string
- DocumentCount: integer
- DocumentPercentage: string
- StorageSize: integer
- StoragePercentage: string
Example
{
"SearchIndexId": "integer",
"IndexName": "string",
"LastSyncDate": "string",
"DocumentCount": "integer",
"DocumentPercentage": "string",
"StorageSize": "integer",
"StoragePercentage": "string"
}
AddTenantViewModel: object
- TenantId: integer
- UserHostAddress: string
- UserAgent: string
- ContactId: integer
- ContactName: string
- ProductId: string
- MembershipTypeId: string
- EndDate: string
- IsActive: boolean
- IsTrial: boolean
- ForInternalUse: boolean
- OnboardingStartDate: string
- OnboardingEndDate: string
- SendLoginInformation: boolean
- CustomFields: string
Example
{
"TenantId": "integer",
"UserHostAddress": "string",
"UserAgent": "string",
"ContactId": "integer",
"ContactName": "string",
"ProductId": "string",
"MembershipTypeId": "string",
"EndDate": "string",
"IsActive": "boolean",
"IsTrial": "boolean",
"ForInternalUse": "boolean",
"OnboardingStartDate": "string",
"OnboardingEndDate": "string",
"SendLoginInformation": "boolean",
"CustomFields": "string"
}
TenantEditViewModel: object
- TenantId: integer
- TenantKey: string
- Name: string
- EditionId: string
- ProductId: string
- IsActive: boolean
- IsDemo: boolean
- IsInternalTenant: boolean
- OnboardingStartDate: string
- OnboardingEndDate: string
- ConversionTypeId: string
- EmailPool: string
- Modules: string
Example
{
"TenantId": "integer",
"TenantKey": "string",
"Name": "string",
"EditionId": "string",
"ProductId": "string",
"IsActive": "boolean",
"IsDemo": "boolean",
"IsInternalTenant": "boolean",
"OnboardingStartDate": "string",
"OnboardingEndDate": "string",
"ConversionTypeId": "string",
"EmailPool": "string",
"Modules": "string"
}
TenantViewModel: object
- TenantId: integer
- ContactsCount: integer
- OrgCount: integer
- PersonCount: integer
- StaffCount: integer
Example
{
"TenantId": "integer",
"ContactsCount": "integer",
"OrgCount": "integer",
"PersonCount": "integer",
"StaffCount": "integer"
}
TenantMembershipModel: object
- GlobalKey: string
- TenantId: integer
- Name: string
- TenantMembershipType: string
- Membership: string
- MembershipId: string
- OrganizationContactId: string
- OrganizationName: string
- MembershipTypeId: string
- EndDate: string
Example
{
"GlobalKey": "string",
"TenantId": "integer",
"Name": "string",
"TenantMembershipType": "string",
"Membership": "string",
"MembershipId": "string",
"OrganizationContactId": "string",
"OrganizationName": "string",
"MembershipTypeId": "string",
"EndDate": "string"
}
SoftwareReleaseViewModel: object
- AppVersionHistoryId: integer
- IsEditable: boolean
- DeploymentDate: string
- Version: string
- Summary: string
- Description: string
- Changes: string
Example
{
"AppVersionHistoryId": "integer",
"IsEditable": "boolean",
"DeploymentDate": "string",
"Version": "string",
"Summary": "string",
"Description": "string",
"Changes": "string"
}
SoftwareReleaseItem: object
- AppVersionHistoryId: integer
- DeploymentDate: string
- Version: string
- Summary: string
Example
{
"AppVersionHistoryId": "integer",
"DeploymentDate": "string",
"Version": "string",
"Summary": "string"
}
EditSwitchAccountModel: object
- LoginId: integer
- DefaultTenantId: integer
- DefaultTenantKey: string
Example
{
"LoginId": "integer",
"DefaultTenantId": "integer",
"DefaultTenantKey": "string"
}
RedirectModel: object
- RedirectToUrl: string
-
The URI to redirect to for the new tenant.
- PostActions: string
Example
{
"RedirectToUrl": "string",
"PostActions": "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"
}