Skip to content

Get field readability for an asset

GET
/assets/{id}/field-composition

Lists every asset field that isn’t archived, with its id, its code and whether you may read this asset’s values of it. It returns no values; use it with GET /assets/{id}/fields to tell a value you may not see from one that was never set.

A field without a read_capability is readable by any signed-in user. Otherwise you need that capability granted globally, or granted for the asset’s team when the asset has one. The list covers every active and deprecated asset field, sorted by code, whatever the asset’s type: it doesn’t check which asset types a field applies to, and it says nothing about whether you may edit a value.

Only the asset’s team is looked up. An id that matches no asset still gets the list, judged on your global capabilities alone, and a deleted asset is judged on its team as before. A form that evaluates display conditions needs this answer: a field you can’t read makes a condition that depends on it unknown, which isn’t the same as a readable field with no value.

id
required
string format: uuid

The asset’s id.

One entry per asset field that isn’t archived, sorted by code. No values are included.

Array<object>

Whether you may read one field’s values on the asset or collection you asked about. It never carries a value.

object
field_id
required

The field definition’s id.

string format: uuid
field_code
required

The field’s code, which display_condition terms use to name it.

string
readable
required

true if you may read this field’s values here: the field has no read_capability, or you hold it globally, or, on an asset with a team, you hold it for that team. When it is false, a form can’t evaluate display conditions that depend on this field.

boolean

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"
}

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed