Docs

Get Collaborator Type

GET /collaborator-types/{typeId}

GET/collaborator-types/{typeId}

Gets one collaborator type with its sections and their attributes, as the type editor shows it. Use it to find sectionIds. The typeId comes from CollaboratorDatabase_GetCollaboratorTypes or CollaboratorDatabase_CreateCollaboratorType.

Path Parameters

FieldTypeRequiredDescription
typeIduuidRequired

Response

FieldTypeDescription
iduuid
namestring| null
iconstring| null
colorstring| null
isArchivedboolean
indexinteger
sectionsGetCollaboratorTypeResponseSectionInfo[]| null

GetCollaboratorTypeResponseSectionInfo

FieldTypeDescription
iduuid
namestring| null
indexinteger
propertiesGetCollaboratorTypeResponsePropertyAssignmentInfo[]| null

GetCollaboratorTypeResponsePropertyAssignmentInfo

FieldTypeDescription
propertyIduuid
namestring| null
typestring| null
isRequiredboolean
isCollaboratorVisibleboolean
isCollaboratorEditableboolean
indexinteger
optionsGetCollaboratorTypeResponseOptionInfo[]| null

GetCollaboratorTypeResponseOptionInfo

FieldTypeDescription
iduuid
labelstring| null