Class Fields

Returns all fields based on the provided query parameters.

Example

const fields = await affinity.fields.all({
    list_id: 123,
    value_type: FieldValueType.TEXT,
    entity_type: ListType.PERSON,
    with_modified_names: true,
})
console.log(fields)
Copy

Creates a new field.

Example

const newField = await affinity.fields.create({
    name: '[Deals] Amount',
    entity_type: 1,
    value_type: 3,
    list_id: 11,
    allows_multiple: false,
    is_list_specific: true,
    is_required: false
})
console.log(newField)
Copy

Deletes a specific field.

Example

const success = await affinity.fields.delete({ field_id: 1234 })
console.log(success ? 'Field deleted': 'Field not deleted')
Copy