Documentation Powered by ReDoc

Growthzone Curated Api (v1)

Download OpenAPI specification:Download

Certifications

CertificationsApi_MarkCertificationComponentCompleted

path Parameters
certificationContactId
required
integer <int32>
certificationComponentId
required
integer <int32>

Responses

Response samples

Content type
application/json
application/json
text/json
{ }

Returns websites tied to contact from contact info.

Returns website names and ids tied to contact id.

path Parameters
contactId
required
integer <int32>

The ID of the contact to return the fields from.

Responses

Response samples

Content type
application/json
application/json
text/json
[]

Look up a list of addresses associated with contact

path Parameters
contactId
required
integer <int32>

The ID of the contact to return the fields from.

Responses

Response samples

Content type
application/json
application/json
text/json
[
  • {
    }
]

Returns a list of groups and their status for a given organizations contact id

path Parameters
ContactId
required
integer <int32>

The ID of the contact to return the fields from.

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "ContactId": 1,
  • "ContactDisplayName": "John Doe",
  • "Groups": [
    ],
  • "GroupMembers": [
    ]
}

Returns custom fields for contact

path Parameters
contactId
required
integer <int32>

The ID of the contact to return the fields from.

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "ContactId": 100,
  • "ObjectTypeId": 0,
  • "SearchObjectTypeId": 0,
  • "AuditId": 0,
  • "Notes": "My Notes",
  • "Bio": "My Bio",
  • "EstablishedDate": "2020-01-01T00:00:00Z",
  • "Naics": null,
  • "Sic": null,
  • "Fields": [
    ],
  • "HasAccessToSetup": true
}

Returns selected categories for contact

path Parameters
contactId
required
integer <int32>

Responses

Response samples

Content type
application/json
application/json
text/json
[
  • {
    }
]

Returns memberships related to individual

path Parameters
ContactId
required
integer <int32>

The ID of the contact to return the fields from.

Responses

Response samples

Content type
application/json
application/json
text/json
[
  • {
    }
]

Gets a list of emails associated with contact id

path Parameters
primaryContactId
required
integer <int32>

The ID of the contact to return the fields from.

Responses

Response samples

Content type
application/json
application/json
text/json
[
  • {
    }
]

Get Contact

Returns summary of one contact, and related records

The return object returns a summary of the contact id specified.
The response will include Memberships, Conftact info, Related contacts, and Related Organizations

path Parameters
ContactId
required
integer <int32>

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "ContactId": 100,
  • "PersonContactId": 100,
  • "ContactOrganizationId": 0,
  • "SystemContactTypeId": 0,
  • "CategoryTypeId": 0,
  • "PrimaryAddressId": null,
  • "PrimaryWebAddressId": null,
  • "PrimaryPhoneId": null,
  • "PrimaryEmailAddressId": null,
  • "ContactDisplayName": null,
  • "FamilyContactsEnabled": false,
  • "RoleRequired": true,
  • "IsDeleted": false,
  • "ContactInfos": null,
  • "Contacts": null,
  • "Organizations": null,
  • "Groups": null,
  • "Activities": [
    ],
  • "Categories": [
    ],
  • "AssignedContacts": [
    ],
  • "Projects": null,
  • "FormsResponses": null,
  • "Certifications": [
    ],
  • "ShouldTrackCertificateCompletion": false,
  • "Memberships": null,
  • "SoftwareAccounts": null,
  • "ContactChapters": null,
  • "IsContactChaptersReadOnly": false,
  • "RelatedIndividuals": null,
  • "ContactExperiences": null,
  • "ChildOrganizations": null,
  • "ParentOrganizations": null,
  • "RelatedOrganizations": null,
  • "Communication": [
    ],
  • "SalesOpportunities": null,
  • "Families": null,
  • "FundraisingActivities": null,
  • "AllowStatusEdit": true
}

Returns list of contacts changed since specified date

Returns a list of contacts modified since the supplied modified datetime.
Returned ordered by the date and time modified.
All date filters are based on UTC time

Example Requests.
Year Month Day: /api/contacts/delta?top=100&modifiedSince=2022-01-01
With Time: /api/contacts/delta?top=100&modifiedSince=2022-01-01T12:00:00

query Parameters
modifiedSince
required
string

Returns contacts modified after this datetime. See endpoint description for format.

top
required
integer <int32>

The number of changed contacts to returned

Responses

Response samples

Content type
application/json
application/json
text/json
[
  • {
    }
]

Returns expanded individual info based on contact id

path Parameters
contactId
required
integer <int32>

The ID of the contact to return the fields from.

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "ContactId": 0,
  • "AuditId": 0,
  • "IsRealEstateEdition": false,
  • "SystemContactTypeId": 1,
  • "PrimaryAddressId": null,
  • "PrimaryEmailAddressId": null,
  • "PrimaryPhoneId": null,
  • "PrimaryWebAddressId": null,
  • "PrimaryContactId": null,
  • "forceSave": false,
  • "NRDSIsStateAssociation": false,
  • "IsPOE": false,
  • "Prefix": null,
  • "FirstName": "John",
  • "MiddleName": null,
  • "LastName": "Doe",
  • "Suffix": null,
  • "CommonName": null,
  • "PrimaryTitle": null,
  • "GenderId": null,
  • "AccountNumber": "1234",
  • "HideAccountNumber": false,
  • "DesignationMsg": "Designations are a one-way sync from M1. Designations entered into Growthzone are not sent to M1.",
  • "ContactDesignations": [ ],
  • "ContactList": [ ],
  • "Addresses": [
    ],
  • "OrganizationsAndRoles": [
    ]
}

Get basic info for individual by contact id

path Parameters
ContactId
required
integer <int32>

The ID of the contact to return the fields from.

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "ContactId": 1000,
  • "LoginId": null,
  • "Prefix": null,
  • "FirstName": "John",
  • "MiddleName": "",
  • "LastName": "Doe",
  • "Suffix": null,
  • "CommonName": "John Doe",
  • "PrimaryOrg": null,
  • "DisplayName": "John Doe",
  • "EmailRelayServiceAddress": null,
  • "PrimaryEmailAddress": "jdoe@example.com",
  • "Balance": 0,
  • "OpenTaskCount": 0,
  • "Status": 0,
  • "Tags": [ ],
  • "ProfileImage": {
    },
  • "Actions": null,
  • "AuditId": 0,
  • "DoNotShowEditName": true
}

Returns values for populating category dropdown.

This endpoint is used to return the status of selected categories for a specific contact.
While contactId is always required, the other two fields can be used in any combination.
The following would all be valid requests:
api/contacts/organization/0/categorychoices/null/null
api/contacts/organization/0/categorychoices/1/1
api/contacts/organization/0/categorychoices/null/1
api/contacts/organization/0/categorychoices/1/null

path Parameters
contactId
required
integer <int32>

The ID of the contact to return the fields from.

categoryTypeId
required
integer <int32>
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

Optional parameter for filtering category type to return. Use null for no value.
categoryTypeId Values:
BusinessContact = 1, IndividualContact = 2, Contact = 3, StoreItem = 4, Membership = 5, SalesOpportunity = 6, Content = 7, Job = 8, HotDeals = 9, Event = 10, Projects = 11, Certifications = 12, Resource = 13, Tickets = 14, SaleableItems = 15, BenefitItems = 16

categoryListId
required
integer <int32>

Optional parameter for limiting to a specific category entry. Use null for no value.

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "ContactId": 1000,
  • "CategoryListId": 1,
  • "CategoryTypeId": 3,
  • "Categories": [
    ],
  • "CategoryListName": "CategoryListName",
  • "DisAllowPrint": true
}

Returns memberships related to organizations

path Parameters
ContactId
required
integer <int32>

The ID of the contact to return the fields from.

Responses

Response samples

Content type
application/json
application/json
text/json
[
  • {
    }
]

Get Contact List

Returns a list of contacts based on query.

Returns a list of contacts in a pagable group.
Takes in full Odata object.
Example Request:
api/contacts?skip=0&take=1&orderBy=ContactId

query Parameters
$orderby
string

Order the results using OData syntax.

$skip
integer

The number of results to skip.

$top
integer

The number of results to return.

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "Criteria": "",
  • "CriteriaItems": [ ],
  • "TotalRecordAvailable": 1,
  • "ModelItems": {
    },
  • "Results": [
    ]
}

Get Groups By Category

GroupsApi_GetGroupsByCategories

Request Body schema:
application/json
application/json
text/json
application/x-www-form-urlencoded
Array
integer <int32>

Responses

Request samples

Content type
application/json
application/json
text/json
application/x-www-form-urlencoded
[
  • 0
]

Response samples

Content type
application/json
application/json
text/json
[
  • {
    }
]

Get Group Data

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

path Parameters
groupId
required
integer <int32>
query Parameters
$orderby
string

Order the results using OData syntax.

$skip
integer

The number of results to skip.

$top
integer

The number of results to return.

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "Criteria": null,
  • "CriteriaItems": null,
  • "TotalRecordAvailable": 1,
  • "ModelItems": null,
  • "Results": [
    ]
}

Get Member Data

Get list of membership statuses for populating dropdown.

Used for dynamically populating dropdown based on up to date membership statuses.

path Parameters
defaultMembershipStatus
required
integer <int32>
Enum: 0 1 2 3 4 5 6 7 8 9

Value to be selected by default
defaultMembershipStatus Values:
NonMember = 0, PendingApproval = 1, Active = 2, Trial = 3, Courtesy = 4, Dropped = 5, Expired = 6, Lead = 7, Prospect = 8, Suspended = 9

Responses

Response samples

Content type
application/json
application/json
text/json
[
  • {
    },
  • {
    }
]

Lookup of all memberships with paging.

Uses OData object to page and order memberships.
Example Request:
/api/memberships/all?skip=0&take=1&OrderBy=MembershipId

query Parameters
$orderby
string

Order the results using OData syntax.

$skip
integer

The number of results to skip.

$top
integer

The number of results to return.

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "Criteria": null,
  • "CriteriaItems": null,
  • "TotalRecordAvailable": 1,
  • "ModelItems": null,
  • "Results": [
    ]
}

Get list of memberships containing specific change event

path Parameters
membershipId
required
integer <int32>

The ID of the membership to return the fields from.

changeType
required
integer <int32>
Enum: 0 1 2 3 4 5

The ID of the contact to return the fields from.
changeType Values:
Upgrade = 0, Downgrade = 1, Other = 2, Drop = 3, Reactivate = 4, Adjustment = 5

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "MembershipId": 0,
  • "ContactId": 100,
  • "SystemContactTypeId": null,
  • "MembershipJoinReasonId": null,
  • "SendNewMemberWelcome": false,
  • "CreateNewMemberProject": false,
  • "ProjectTemplateId": null,
  • "ChangeType": 0,
  • "Change": "Upgrade",
  • "MembershipTypeId": null,
  • "OldMembershipTypeId": null,
  • "MembershipLevelId": null,
  • "DurationMonths": 0,
  • "ChapterId": null,
  • "SalesContactId": null,
  • "Notes": null,
  • "Fields": null,
  • "Instructions": "",
  • "PlanOrFrequencyId": null,
  • "NextBillingDate": null,
  • "StartDate": "0001-01-01T00:00:00Z",
  • "FeeItems": [ ],
  • "OncePerTermFeeItems": [ ],
  • "OneTimeFeeItems": [ ],
  • "OldFeeItems": null,
  • "MembershipTypeDurationMonths": 0,
  • "MembershipTypeFixedAnnualRenewalMonth": null,
  • "FixedAnnualRenewalMonth": null,
  • "Name": "Upgrade",
  • "PrintInvoice": false,
  • "EmailInvoice": false,
  • "BillingContactId": null,
  • "ResponsiblePartyContactName": null,
  • "ResponsiblePartyContactId": null,
  • "HasBillingResponsibleParty": false,
  • "BillingResponsiblePartyRoleTypeId": null,
  • "ResponsiblePartyTypeId": null,
  • "BillingAddressId": null,
  • "BillingEmailId": null,
  • "TermId": null,
  • "InvoiceMessage": null,
  • "BillingStartDate": "0001-01-01T00:00:00Z",
  • "SameNextBillDates": true,
  • "ExpirationDate": null,
  • "MembershipRenewalTypeId": 0,
  • "MembershipEndTypeId": 0,
  • "GracePeriodExpirationDate": "0001-01-01T00:00:00Z",
  • "RenewalNotificationDate": "0001-01-01T00:00:00Z",
  • "Yesterday": "2024-07-17T13:42:55.9012809Z",
  • "PricingTypeId": 0,
  • "RoundToNearestOnes": false,
  • "PaymentGatewayId": null,
  • "VoluntaryItems": null,
  • "ChapterIds": null,
  • "PurchaseIds": null,
  • "InvoiceNumber": null,
  • "HasLevels": false,
  • "GracePeriodDays": 0,
  • "InitialExpirationDate": null,
  • "DisableDateEditing": false,
  • "SendStaffNotifications": true
}

Returns list of membership types with paging parameters

Uses OData object to page and order member types.
Example Request:
/api/membership/types?skip=0&take=1&orderBy=MembershipTypeId

query Parameters
$orderby
string

Order the results using OData syntax.

$skip
integer

The number of results to skip.

$top
integer

The number of results to return.

Responses

Response samples

Content type
application/json
application/json
text/json
{
  • "Criteria": null,
  • "CriteriaItems": null,
  • "TotalRecordAvailable": 1,
  • "ModelItems": null,
  • "Results": [
    ]
}