Cirqll Core
HomeCirqll
HomeCirqll
  1. Documentation
  • Getting Started
  • Translations
  • Documentation
    • Field Values
    • Zapier
      • Triggers
      • Actions
    • Query Parameters
      • Eager Loading
      • Partial Data
      • Count Relations
      • Filter
      • Order By
      • Pagination
    • OAuth2
      • User
      • Client
        • Index
        • Create
        • Update
        • Delete
      • Token
        • Create
        • Refresh
        • Index
      • Scopes
      • Authorize
      • Me
    • Authentication
  • User
    • Me
      GET
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Role
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Customer
    • Index
      GET
    • Show
      GET
    • Delete
      DELETE
    • Update
      PATCH
    • Create
      POST
  • Contact
    • Index
      GET
    • Show
      GET
    • Create
      POST
    • Update
      PATCH
    • Delete
      DELETE
  • Task
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Appointment
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Financial
    • Chance
      • Index
      • Show
      • Create
      • Update
      • Delete
    • Assignment
      • Index
      • Show
      • Create
      • Update
      • Delete
    • Contract
      • Index
      • Show
      • Create
      • Update
      • Delete
  • Email
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Field
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Note
    • Index
    • Show
    • Create
    • Update
    • Delete
  • To-do
    • Index
    • Show
    • Create
    • Update
    • Delete
  • Template
    • Index
    • Show
    • Update
    • Create
    • Delete
  • Setting
    • Index
    • Update
  • Webhook
    • Index
    • Show
    • Create
    • Update
    • Delete
  1. Documentation

Field Values

Also known as custom metadata or additional attributes. Field values exist to provide additional information within Cirqll.
For easy management we recommend setting them up in the preferences page on frontend.
image.png
It is also possible to configure them with the API. Checkout the endpoints in https://docs.api.cirqll.nl/api-field for more information.
Fields are not the same as Field Values.
Fields describe which field values are allowed to be set.

Required Fields#

Required fields are also required in the API. When you are missing required fields you will get this error:
The number in the parentheses is the ID of the field which is required.
{
    "message": "Missing field values with required values: Labels (1) (and 1 more error)",
    "errors": {
        "field_values": [
            "Missing field values with required values: Labels (1)",
            "The field values field is required."
        ]
    }
}

Passing Field Values#

As said before; you can only pass field values when fields have been configured.
To provide some examples using field values, assume that the following fields exist.
// Irrelevant fields hidden for brevity.
{
    "data": [
        {
            "id": 1,
            "name": "Labels",
            "category": "customer",
            // "labels" is the same as "multiselect" but will be shown in frontend modals
            "type": "labels",
            "required": true,
            "options": [
                { "value": "PaleTurquoise" },
                { "value": "DarkViolet" },
                { "value": "LightGray" },
                { "value": "Silver" }
            ]
        },
        {
            "id": 2,
            "name": "Datum Veld",
            "category": "customer",
            "type": "date",
            "required": false
        },
        {
            "id": 3,
            "name": "Kleur",
            "category": "customer",
            "type": "select",
            "required": false,
            "options": [
                { "value": "Red" },
                { "value": "Green" },
                { "value": "Blue" }
            ]
        },
    ],
    "limit": 100,
    "total": 2,
    "offset": 0
}
Below you can find an example on how to pass field values when creating a Customer.
{
    "name": "example",
    "field_values": [
        // is labels/multiselect so we use an array
        { "field_id": 1, "value": ["LightGray", "Silver"] },
        // is date so we use ISO date
        { "field_id": 2, "value": "2025-10-31" },
        // is select we expect one value
        { "field_id": 3, "value": "Red" },
        
        // other examples
        { "field_id": -1, "value": 1 }, // price
        { "field_id": -1, "value": "https://google.com" }, // url
        { "field_id": -1, "value": "can be any text" }, // text
        { "field_id": -1, "value": true } // yesno (bool)
    ]
}

Where can I use Field Values?#

Customers
Contacts
Tasks
Appointment
Financial
Chances
Contracts
Assignments
Modified at 2025-10-31 13:58:14
Previous
Translations
Next
Zapier
Built with