CustomField

The band’s own fields on core tables. Each row is one real column, named with the x_ prefix, on the table it belongs to. Retiring a field hides it everywhere and keeps its data.

created_time
Type: stringFormat: date-time
read-only
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
description
Type: string | null
required
entity
Type: string | null
required

The table the field is on, e.g. gigs or venues. Fixed once created.
field_type
Type: string | nullenum
required

Fixed once created; to change a field’s type, retire it and add a new one.
values
- rich_text
- number
- currency
- date
- time
- checkbox
- select
- multi_select
id
Type: stringFormat: uuid
read-only
required
key
Type: string | null
required

The column name: lowercase, starting with x_. Fixed once created.
label
Type: string | null
required
last_edited_time
Type: stringFormat: date-time
read-only
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
options
Type: array of string | null
required

The allowed values of a select or multi_select field.
order
Type: number | null
required
relation
Type: string | null
required

The table a relation field points at. Fixed once created.
required
Type: boolean
required

New records must supply a value. Checked by the API, not the database.
status
Type: "active" or "retired" or nullenum
required

A retired field is hidden from the API and the app; its column and data stay.