• Properties

Properties

We have two types of properties:

  • Built-in properties: Properties created by the system.
  • Properties for an account: Custom properties specific to an account.

PropertiesTypes

  • string: A basic string type.
  • text: A longer text type.
  • single_select: A single selection from predefined options. by internal_name for option
  • date: A date value. (ISO 8601 format)
  • time: A time value in string format.
  • dateTime: A combined date and time value. (ISO 8601 format)
  • number: A numeric value.
  • currency: A currency value.
  • image: An image file.
  • user: An integer representing a user ID.
  • team: An integer representing a team ID.
  • phone_number: A phone number matching the regex pattern: regex:/^+[0-9]+$/.

single_select example

{
  "enum": [
    {
      "en": "Male",
      "ar": "ذكر",
      "internal_name": "male"
    },
    {
      "en": "Female",
      "ar": "أُنثى",
      "internal_name": "female"
    }
  ]
}

Note

If the property system_only is set to true, it means it's not possible to set a value for this field when creating or updating the object.