Description This API endpoint allows the retrieval of attributes associated with a specified target, which can be either a “collection” or “list.” Attributes provide information about the nature and characteristics of data stored within a collection or list.
Path Specifies the target type, which can be either “collection” or “list.”
A unique identifier for the target, either a collection ID or a list ID,
depending on the target type.
Response Indicates the success or failure of the attribute retrieval. In this case,
true signifies a successful operation.
Provides a human-readable message accompanying the response. In this instance,
it confirms the successful retrieval of attributes with the message “success.”
An array containing details of the retrieved attributes. For each attribute in
the data array:
A unique identifier for the attribute, allowing for precise referencing.
The API key name used to store data in the collection or list for this
field.
Defines the input type or nature of the field. Possible values include
text, number, checkbox, currency, date, timestamp, rating, status, select,
multiselect, record-reference, actor-reference, domain, file, ai-wizard,
email-address, phone-number.
The human-readable name of the field.
Configuration settings for the attribute, including currency display type,
currency code, record reference, AI wizard, and date display type.
Accepted values: “code,” “name,” “narrowSymbol,” “symbol.” Specifies
how currency should be displayed.
The currency code (e.g., “EUR,” “GBP,” “USD,” “CAD,” “AUD”).
An array of collection ids connected to this attribute.
The AI wizard field prompt.
Defines how to display the date field.
The default value for the attribute.
A description providing additional information about the attribute.
Indicates whether the attribute is archived (true/false).
Indicates whether the default value is enabled for the attribute
(true/false).
Indicates whether the attribute is editable (true/false).
Indicates whether the attribute supports multiple selections (true/false).
Indicates whether the attribute is required (true/false).
Indicates whether the attribute is a system attribute (true/false).
Indicates whether the attribute values must be unique (true/false).
The validation type for the attribute. Possible values include “none,”
“email,” “url,” “phone,” “customRegex.”
200-Success
401-Unauthorised
{ "status" : true ,
"message" : "success" ,
"data" : [
{
"_id" : "64ad815b273e66dae1afe10f" ,
"apiKeyName" : "name" ,
"inputType" : "text" ,
"name" : "Name" ,
"config" : {
"currencyDisplayType" : null ,
"currencyCode" : null ,
"recordReference" : [ ] ,
"aiWizard" : null ,
"dateDisplayType" : null
} ,
"defaultValue" : null ,
"description" : "" ,
"isArchived" : false ,
"isDefaultValueEnabled" : false ,
"isEditable" : true ,
"isMultiSelect" : false ,
"isRequired" : false ,
"isSystemAttribute" : true ,
"isUniuqe" : false ,
"validation" : "none" ,
"isUnique" : false
} ,
]
} 
