GrowthZone REST API API Reference
undefined
API Endpoint
https://app.memberzone.orgRequest Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0
Paths
GET /api/customfields
filter:
string
in query
(no description)
OK
Response Example (200 OK)
[
{
"CustomFieldId": "integer",
"AuditId": "integer",
"ObjectTypeId": "string",
"ObjectType": "string",
"Name": "string",
"Description": "string",
"DisplayName": "string",
"GroupName": "string",
"IsSystem": "boolean",
"CustomFieldDataTypeId": "string",
"CustomFieldDataType": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean"
}
]
GET /api/customfields/{customfieldid}
customfieldid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer"
}
POST /api/customfields/{customfieldid}
undefined
customfieldid:
integer
in path
(no description)
Request Example
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer"
}
OK
Response Example (200 OK)
{
"CustomFieldId": "integer",
"AuditId": "integer",
"ObjectTypeId": "string",
"ObjectType": "string",
"Name": "string",
"Description": "string",
"DisplayName": "string",
"GroupName": "string",
"IsSystem": "boolean",
"CustomFieldDataTypeId": "string",
"CustomFieldDataType": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean"
}
DELETE /api/customfields/{customfieldid}/{auditid}
customfieldid:
integer
in path
(no description)
auditid:
integer
in path
(no description)
200 OK
OK
GET /api/customfields/contentlists/{contentlistid}/{customfieldid}
contentlistid:
integer
in path
(no description)
customfieldid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer"
}
POST /api/customfields/directorylisting/{customfieldid}
undefined
customfieldid:
integer
in path
(no description)
Request Example
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer",
"ActiveListingTypes": "string"
}
OK
Response Example (200 OK)
{
"CustomFieldId": "integer",
"AuditId": "integer",
"ObjectTypeId": "string",
"ObjectType": "string",
"Name": "string",
"Description": "string",
"DisplayName": "string",
"GroupName": "string",
"IsSystem": "boolean",
"CustomFieldDataTypeId": "string",
"CustomFieldDataType": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean"
}
GET /api/customfields/directorylisting/{directoryid}/{customfieldid}
directoryid:
integer
in path
(no description)
customfieldid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer",
"ActiveListingTypes": "string"
}
GET /api/customfields/edition
filter:
string
in query
(no description)
OK
Response Example (200 OK)
{
"ObjectTypeId": "string",
"CustomFields": "string",
"MLSType": "string"
}
GET /api/customfields/editioncustomfields
200 OK
OK
Response Example (200 OK)
{
"SearchObjectTypeId": "string",
"CustomFieldSettings": "string"
}
POST /api/customfields/editioncustomfields
undefined
Request Example
{
"SearchObjectTypeId": "string",
"CustomFieldSettings": "string"
}
200 OK
OK
GET /api/customfields/fields/{membershiptypeid}/unit/lookup
membershiptypeid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/customfields/form/{formid}/sections/lookup
formid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
POST /api/customfields/getall
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"ExcludeSystemObjectTypeId": "string",
"OnlyIncludeSystemObjectTypeId": "string"
}
OK
Response Example (200 OK)
[
{
"CustomFieldId": "integer",
"AuditId": "integer",
"ObjectTypeId": "string",
"ObjectType": "string",
"Name": "string",
"Description": "string",
"DisplayName": "string",
"GroupName": "string",
"IsSystem": "boolean",
"CustomFieldDataTypeId": "string",
"CustomFieldDataType": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean"
}
]
GET /api/customfields/gettenantcustomfield/{customfieldid}
customfieldid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"PersonCustomFieldValueId": "integer",
"IsDeleted": "boolean",
"ContactId": "integer",
"TenantId": "integer",
"CustomFieldId": "integer",
"Value": "string",
"AuditId": "integer",
"IsCustomFieldGroupExists": "boolean",
"CustomFieldGroupName": "string",
"CustomFieldGroupDisplayOrder": "string",
"CustomFieldGroupIsDeleted": "boolean",
"ObjectTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"StandardFieldId": "string",
"DataSize": "string",
"SelectListData": "string",
"CustomFieldGroupId": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"DisplayOrder": "string",
"CustomFieldAuditId": "integer",
"CustomFieldIsDeleted": "boolean",
"IsSingleUse": "boolean",
"DisplayWidth": "string",
"Contact": "string",
"IsSystem": "boolean"
}
GET /api/customfields/groups/{customfieldgroupid}
customfieldgroupid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"CustomFieldGroupId": "integer",
"CustomFieldGroupName": "string",
"DisplayOrder": "string"
}
POST /api/customfields/groups/{customfieldgroupid}
undefined
customfieldgroupid:
integer
in path
(no description)
Request Example
{
"CustomFieldGroupId": "integer",
"CustomFieldGroupName": "string",
"DisplayOrder": "string"
}
200 OK
OK
Response Example (200 OK)
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
DELETE /api/customfields/groups/{customfieldgroupid}
customfieldgroupid:
integer
in path
(no description)
200 OK
OK
GET /api/customfields/groups/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/customfields/lookup/{searchobjecttypeid}/{contentlistid}/{directoryid}/{formid}/{membershiptypeoptionid}/{projecttypeid}/{membershiptypeid}
searchobjecttypeid:
string
in path
(no description)
contentlistid:
string
in path
(no description)
directoryid:
string
in path
(no description)
formid:
string
in path
(no description)
membershiptypeoptionid:
string
in path
(no description)
projecttypeid:
string
in path
(no description)
membershiptypeid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer"
}
]
GET /api/customfields/lookup/events
200 OK
OK
GET /api/customfields/lookup/forms
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/customfields/lookup/individuals
200 OK
OK
GET /api/customfields/lookup/membershippolicy
200 OK
OK
GET /api/customfields/lookup/memberships
200 OK
OK
GET /api/customfields/lookup/membershiptype
200 OK
OK
GET /api/customfields/lookup/withareas/{objecttypeid}
objecttypeid:
string
in path
(no description)
200 OK
OK
DELETE /api/customfields/manage/{customfieldid}/{auditid}/{objecttypeid}/{searchobjecttypeid}/{contentlistid}/{directoryid}/{formid}/{membershiptypeoptionid}/{projecttypeid}/{membershiptypeid}
customfieldid:
integer
in path
(no description)
auditid:
integer
in path
(no description)
objecttypeid:
string
in path
(no description)
searchobjecttypeid:
string
in path
(no description)
contentlistid:
string
in path
(no description)
directoryid:
string
in path
(no description)
formid:
string
in path
(no description)
membershiptypeoptionid:
string
in path
(no description)
projecttypeid:
string
in path
(no description)
membershiptypeid:
string
in path
(no description)
200 OK
OK
POST /api/customfields/manage/{objecttypeid}
undefined
objecttypeid:
object
in path
(no description)
Request Example
{
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Fields": "string"
}
OK
Response Example (200 OK)
[
{
"CustomFieldId": "integer",
"AuditId": "integer",
"ObjectTypeId": "string",
"ObjectType": "string",
"Name": "string",
"Description": "string",
"DisplayName": "string",
"GroupName": "string",
"IsSystem": "boolean",
"CustomFieldDataTypeId": "string",
"CustomFieldDataType": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean"
}
]
GET /api/customfields/manage/{objecttypeid}/{searchobjecttypeid}/{contentlistid}/{directoryid}/{formid}/{membershiptypeoptionid}/{projecttypeid}
objecttypeid:
string
in path
(no description)
searchobjecttypeid:
string
in path
(no description)
contentlistid:
string
in path
(no description)
directoryid:
string
in path
(no description)
formid:
string
in path
(no description)
membershiptypeoptionid:
string
in path
(no description)
projecttypeid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Fields": "string"
}
GET /api/customfields/manage/membershiptype/{membershiptypeid}
membershiptypeid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Fields": "string"
}
GET /api/customfields/managegroups
200 OK
OK
Response Example (200 OK)
{
"CustomFieldGroups": "string"
}
POST /api/customfields/membershiptype/{customfieldid}
customfieldid:
integer
in path
(no description)
Request Example
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer",
"IsModified": "boolean"
}
OK
Response Example (200 OK)
{
"CustomFieldId": "integer",
"AuditId": "integer",
"ObjectTypeId": "string",
"ObjectType": "string",
"Name": "string",
"Description": "string",
"DisplayName": "string",
"GroupName": "string",
"IsSystem": "boolean",
"CustomFieldDataTypeId": "string",
"CustomFieldDataType": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean"
}
GET /api/customfields/membershiptype/{membershiptypeid}/memberapp/{customfieldid}
membershiptypeid:
integer
in path
(no description)
customfieldid:
integer
in path
(no description)
Response Example (200 OK)
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer",
"IsModified": "boolean"
}
GET /api/customfields/membershiptype/{membershiptypeoptionid}/{customfieldid}
membershiptypeoptionid:
integer
in path
(no description)
customfieldid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer"
}
GET /api/customfields/membershiptypenumeric/{membershiptypeid}/memberapp/{customfieldid}
membershiptypeid:
integer
in path
(no description)
customfieldid:
integer
in path
(no description)
Response Example (200 OK)
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer",
"IsModified": "boolean"
}
GET /api/customfields/ordercustomfields/{objecttypeid}/{fieldgroupname}
objecttypeid:
string
in path
(no description)
fieldgroupname:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Fields": "string"
}
GET /api/customfields/projectcustomfield/{projecttypeid}/{customfieldid}
projecttypeid:
string
in path
(no description)
customfieldid:
string
in path
(no description)
OK
Response Example (200 OK)
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer"
}
GET /api/customfields/standardfields/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
Schema Definitions
CustomFieldCollectionItemModel: object
- CustomFieldId: integer
- AuditId: integer
- ObjectTypeId: string
- ObjectType: string
- Name: string
- Description: string
- DisplayName: string
- GroupName: string
- IsSystem: boolean
- CustomFieldDataTypeId: string
- CustomFieldDataType: string
- IsPublic: boolean
- IsMemberEditable: boolean
- IsRequired: boolean
- IsArchived: boolean
Example
{
"CustomFieldId": "integer",
"AuditId": "integer",
"ObjectTypeId": "string",
"ObjectType": "string",
"Name": "string",
"Description": "string",
"DisplayName": "string",
"GroupName": "string",
"IsSystem": "boolean",
"CustomFieldDataTypeId": "string",
"CustomFieldDataType": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean"
}
CustomFieldAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- ExcludeSystemObjectTypeId: string
- OnlyIncludeSystemObjectTypeId: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"ExcludeSystemObjectTypeId": "string",
"OnlyIncludeSystemObjectTypeId": "string"
}
EditionCustomFieldCollectionItemModel: object
- ObjectTypeId: string
- CustomFields: string
- MLSType: string
Example
{
"ObjectTypeId": "string",
"CustomFields": "string",
"MLSType": "string"
}
EditionCustomFieldModel: object
- SearchObjectTypeId: string
- CustomFieldSettings: string
Example
{
"SearchObjectTypeId": "string",
"CustomFieldSettings": "string"
}
CustomFieldAddEditModel: object
- Id: integer
- CustomFieldId: integer
- AuditId: integer
- ForceFormDisabled: boolean
-
This is required for cases when we have to disable form controls
- HideDescription: boolean
- ShowDescription: boolean
- ObjectTypeId: string
- ObjectType: string
- Exists: boolean
- SearchObjectTypeId: string
- ExistingCustomFieldId: string
- ContentListId: string
- DirectoryId: string
- FormId: string
- MembershipTypeOptionId: string
- ProjectTypeId: string
- MembershipTypeId: string
- Name: string
- DisplayName: string
- Description: string
- CustomFieldDataTypeId: string
- ScaleModel: string
- CustomFieldGroupId: string
- DataSize: string
- StandardFieldId: string
- SelectListData: string
- SelectListItems: string
- ChildCustomFields: string
- IsPublic: boolean
- IsMemberEditable: boolean
- IsRequired: boolean
- IsArchived: boolean
- ExternalDataSource: string
- DisplayOrder: string
- HasValues: boolean
- CssClass: string
- TenantId: integer
Example
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer"
}
MembershipTypeMemberAppCustomFieldAddEditModel: object
- Id: integer
- CustomFieldId: integer
- AuditId: integer
- ForceFormDisabled: boolean
-
This is required for cases when we have to disable form controls
- HideDescription: boolean
- ShowDescription: boolean
- ObjectTypeId: string
- ObjectType: string
- Exists: boolean
- SearchObjectTypeId: string
- ExistingCustomFieldId: string
- ContentListId: string
- DirectoryId: string
- FormId: string
- MembershipTypeOptionId: string
- ProjectTypeId: string
- MembershipTypeId: string
- Name: string
- DisplayName: string
- Description: string
- CustomFieldDataTypeId: string
- ScaleModel: string
- CustomFieldGroupId: string
- DataSize: string
- StandardFieldId: string
- SelectListData: string
- SelectListItems: string
- ChildCustomFields: string
- IsPublic: boolean
- IsMemberEditable: boolean
- IsRequired: boolean
- IsArchived: boolean
- ExternalDataSource: string
- DisplayOrder: string
- HasValues: boolean
- CssClass: string
- TenantId: integer
- IsModified: boolean
Example
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer",
"IsModified": "boolean"
}
MembershipTypeMemberAppNumericCustomFieldAddEditModel: object
- Id: integer
- CustomFieldId: integer
- AuditId: integer
- ForceFormDisabled: boolean
-
This is required for cases when we have to disable form controls
- HideDescription: boolean
- ShowDescription: boolean
- ObjectTypeId: string
- ObjectType: string
- Exists: boolean
- SearchObjectTypeId: string
- ExistingCustomFieldId: string
- ContentListId: string
- DirectoryId: string
- FormId: string
- MembershipTypeOptionId: string
- ProjectTypeId: string
- MembershipTypeId: string
- Name: string
- DisplayName: string
- Description: string
- CustomFieldDataTypeId: string
- ScaleModel: string
- CustomFieldGroupId: string
- DataSize: string
- StandardFieldId: string
- SelectListData: string
- SelectListItems: string
- ChildCustomFields: string
- IsPublic: boolean
- IsMemberEditable: boolean
- IsRequired: boolean
- IsArchived: boolean
- ExternalDataSource: string
- DisplayOrder: string
- HasValues: boolean
- CssClass: string
- TenantId: integer
- IsModified: boolean
Example
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer",
"IsModified": "boolean"
}
DirectoryCustomFieldAddEditModel: object
- Id: integer
- CustomFieldId: integer
- AuditId: integer
- ForceFormDisabled: boolean
-
This is required for cases when we have to disable form controls
- HideDescription: boolean
- ShowDescription: boolean
- ObjectTypeId: string
- ObjectType: string
- Exists: boolean
- SearchObjectTypeId: string
- ExistingCustomFieldId: string
- ContentListId: string
- DirectoryId: string
- FormId: string
- MembershipTypeOptionId: string
- ProjectTypeId: string
- MembershipTypeId: string
- Name: string
- DisplayName: string
- Description: string
- CustomFieldDataTypeId: string
- ScaleModel: string
- CustomFieldGroupId: string
- DataSize: string
- StandardFieldId: string
- SelectListData: string
- SelectListItems: string
- ChildCustomFields: string
- IsPublic: boolean
- IsMemberEditable: boolean
- IsRequired: boolean
- IsArchived: boolean
- ExternalDataSource: string
- DisplayOrder: string
- HasValues: boolean
- CssClass: string
- TenantId: integer
- ActiveListingTypes: string
Example
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer",
"ActiveListingTypes": "string"
}
ProjectCustomFieldAddEditModel: object
- Id: integer
- CustomFieldId: integer
- AuditId: integer
- ForceFormDisabled: boolean
-
This is required for cases when we have to disable form controls
- HideDescription: boolean
- ShowDescription: boolean
- ObjectTypeId: string
- ObjectType: string
- Exists: boolean
- SearchObjectTypeId: string
- ExistingCustomFieldId: string
- ContentListId: string
- DirectoryId: string
- FormId: string
- MembershipTypeOptionId: string
- ProjectTypeId: string
- MembershipTypeId: string
- Name: string
- DisplayName: string
- Description: string
- CustomFieldDataTypeId: string
- ScaleModel: string
- CustomFieldGroupId: string
- DataSize: string
- StandardFieldId: string
- SelectListData: string
- SelectListItems: string
- ChildCustomFields: string
- IsPublic: boolean
- IsMemberEditable: boolean
- IsRequired: boolean
- IsArchived: boolean
- ExternalDataSource: string
- DisplayOrder: string
- HasValues: boolean
- CssClass: string
- TenantId: integer
Example
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer"
}
ContentListCustomFieldAddEditModel: object
- Id: integer
- CustomFieldId: integer
- AuditId: integer
- ForceFormDisabled: boolean
-
This is required for cases when we have to disable form controls
- HideDescription: boolean
- ShowDescription: boolean
- ObjectTypeId: string
- ObjectType: string
- Exists: boolean
- SearchObjectTypeId: string
- ExistingCustomFieldId: string
- ContentListId: string
- DirectoryId: string
- FormId: string
- MembershipTypeOptionId: string
- ProjectTypeId: string
- MembershipTypeId: string
- Name: string
- DisplayName: string
- Description: string
- CustomFieldDataTypeId: string
- ScaleModel: string
- CustomFieldGroupId: string
- DataSize: string
- StandardFieldId: string
- SelectListData: string
- SelectListItems: string
- ChildCustomFields: string
- IsPublic: boolean
- IsMemberEditable: boolean
- IsRequired: boolean
- IsArchived: boolean
- ExternalDataSource: string
- DisplayOrder: string
- HasValues: boolean
- CssClass: string
- TenantId: integer
Example
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer"
}
CustomFieldLookupOption: object
- Id: integer
- CustomFieldId: integer
- AuditId: integer
- ForceFormDisabled: boolean
-
This is required for cases when we have to disable form controls
- HideDescription: boolean
- ShowDescription: boolean
- ObjectTypeId: string
- ObjectType: string
- Exists: boolean
- SearchObjectTypeId: string
- ExistingCustomFieldId: string
- ContentListId: string
- DirectoryId: string
- FormId: string
- MembershipTypeOptionId: string
- ProjectTypeId: string
- MembershipTypeId: string
- Name: string
- DisplayName: string
- Description: string
- CustomFieldDataTypeId: string
- ScaleModel: string
- CustomFieldGroupId: string
- DataSize: string
- StandardFieldId: string
- SelectListData: string
- SelectListItems: string
- ChildCustomFields: string
- IsPublic: boolean
- IsMemberEditable: boolean
- IsRequired: boolean
- IsArchived: boolean
- ExternalDataSource: string
- DisplayOrder: string
- HasValues: boolean
- CssClass: string
- TenantId: integer
Example
{
"Id": "integer",
"CustomFieldId": "integer",
"AuditId": "integer",
"ForceFormDisabled": "boolean",
"HideDescription": "boolean",
"ShowDescription": "boolean",
"ObjectTypeId": "string",
"ObjectType": "string",
"Exists": "boolean",
"SearchObjectTypeId": "string",
"ExistingCustomFieldId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"ScaleModel": "string",
"CustomFieldGroupId": "string",
"DataSize": "string",
"StandardFieldId": "string",
"SelectListData": "string",
"SelectListItems": "string",
"ChildCustomFields": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"ExternalDataSource": "string",
"DisplayOrder": "string",
"HasValues": "boolean",
"CssClass": "string",
"TenantId": "integer"
}
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"
}
ManageCustomFieldsModel: object
- ObjectTypeId: string
- SearchObjectTypeId: string
- ContentListId: string
- DirectoryId: string
- FormId: string
- MembershipTypeOptionId: string
- ProjectTypeId: string
- MembershipTypeId: string
- Fields: string
Example
{
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"Fields": "string"
}
AddEditCustomFieldGroupModel: object
- CustomFieldGroupId: integer
- CustomFieldGroupName: string
- DisplayOrder: string
Example
{
"CustomFieldGroupId": "integer",
"CustomFieldGroupName": "string",
"DisplayOrder": "string"
}
SyncCustomFieldDto: object
- PersonCustomFieldValueId: integer
- IsDeleted: boolean
- ContactId: integer
- TenantId: integer
- CustomFieldId: integer
- Value: string
- AuditId: integer
- IsCustomFieldGroupExists: boolean
- CustomFieldGroupName: string
- CustomFieldGroupDisplayOrder: string
- CustomFieldGroupIsDeleted: boolean
- ObjectTypeId: string
- Name: string
- DisplayName: string
- Description: string
- CustomFieldDataTypeId: string
- StandardFieldId: string
- DataSize: string
- SelectListData: string
- CustomFieldGroupId: string
- IsPublic: boolean
- IsMemberEditable: boolean
- IsRequired: boolean
- IsArchived: boolean
- DisplayOrder: string
- CustomFieldAuditId: integer
- CustomFieldIsDeleted: boolean
- IsSingleUse: boolean
- DisplayWidth: string
- Contact: string
- IsSystem: boolean
Example
{
"PersonCustomFieldValueId": "integer",
"IsDeleted": "boolean",
"ContactId": "integer",
"TenantId": "integer",
"CustomFieldId": "integer",
"Value": "string",
"AuditId": "integer",
"IsCustomFieldGroupExists": "boolean",
"CustomFieldGroupName": "string",
"CustomFieldGroupDisplayOrder": "string",
"CustomFieldGroupIsDeleted": "boolean",
"ObjectTypeId": "string",
"Name": "string",
"DisplayName": "string",
"Description": "string",
"CustomFieldDataTypeId": "string",
"StandardFieldId": "string",
"DataSize": "string",
"SelectListData": "string",
"CustomFieldGroupId": "string",
"IsPublic": "boolean",
"IsMemberEditable": "boolean",
"IsRequired": "boolean",
"IsArchived": "boolean",
"DisplayOrder": "string",
"CustomFieldAuditId": "integer",
"CustomFieldIsDeleted": "boolean",
"IsSingleUse": "boolean",
"DisplayWidth": "string",
"Contact": "string",
"IsSystem": "boolean"
}