Skip to content

List a field's team default overrides

GET
/fields/{id}/default-overrides

Lists the teams that use their own upload default for this field instead of the field’s default_value. Requires the fields.admin or system.admin capability, granted globally.

An override only fills in a value when an asset is created; it never changes values already stored. Overrides of deleted teams are left out. The list is sorted by team name and comes back in one response, with no paging.

id
required
string format: uuid

The field definition’s id.

The overrides, sorted by team name. Deleted teams’ overrides are not included.

Array<object>

One team’s override of a field’s upload default.

object
field_id
required

The field definition’s id.

string format: uuid
team_id
required

The team’s id.

string format: uuid
team_slug
required

The team’s slug.

string
team_name
required

The team’s name.

string
default_value
required

An upload default: either a fixed value (literal) or a value the server fills in when the asset is created (context). It is never a formula.

For a literal, set only the value_* member the field’s type uses; setting another member is refused with 400. On select, multi_select and tree fields the slugs must be active terms of the field. Upload defaults suit values chosen in advance; values read from the file come from metadata extraction instead.

object
kind
required

literal for a fixed value, context for one the server fills in when the asset is created.

string
Allowed values: literal context
value_text

The literal value for text, longtext, rich_text, select and tree fields. For select and tree, an active slug.

string
nullable
value_num

The literal value for number and boolean fields. A boolean is 1 or 0.

number
nullable
value_date

The literal value for date and datetime fields.

string format: date-time
nullable
value_options

The literal value for multi_select fields: active slugs.

Array<string>
nullable
value_ref

The literal value for reference fields: an asset id.

string format: uuid
nullable
context

Required when kind is context, and not allowed otherwise. The server fills in the value when the asset is created:

  • uploading_user: the uploader’s full name from their account, or their username if no full name is set. Use it on text fields.
  • uploading_team: the name of the uploader’s team. Use it on text fields. Skipped when the uploader belongs to no team or to more than one.
  • current_date: the creation time, for date and datetime fields. A date field gets the day (UTC), a datetime field the exact time.

These three are the only choices.

string
Allowed values: uploading_user uploading_team current_date
created_at
required

When the override was first set. Setting it again keeps this time.

string format: date-time
updated_at
required

When the override was last set.

string format: date-time
updated_by_user_ref

The account that last set the override.

integer format: int64
nullable

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed