Skip to navigation
Virtuous RaiseCustom Field

Get a custom field by its ID.

Authentication

Authorizationstring

JWT Authorization header using the Bearer scheme. Example: “Authorization: Bearer {token}”

Path parameters

idlongRequired
The ID of the custom field.

Response

OK
idlongOptional
Gets or sets the identifier.
customCollectionIdlong or nullOptional
Gets or sets the custom collection identifier.
namestring or nullOptional
Gets or sets the name.
displayNamestring or nullOptional
Gets or sets the display name.
entityTypeenumOptional
Gets or sets the entity type.
entityTypeDisplayNamestring or nullOptional
Gets or sets the entity type display name.
dataTypeenumOptional
Gets or sets the data type.
dataTypeDisplayNamestring or nullOptional
Gets or sets the data type display name.
isEnabledbooleanOptional
Gets or sets a value indicating whether this instance is enabled.
canSyncbooleanOptional
Gets or sets a value indicating whether this instance is required.
formatterenumOptional
Gets or sets the formatter.
listValueslist of objects or nullOptional
Gets or sets the list values.
rankdouble or nullOptional
Gets or sets the rank of the custom field.
requiredbooleanOptional
Gets or sets a value indicating whether this custom field is required.

Errors

404
Not Found Error