Skip to content

Get field readability for a collection

GET
/collections/{id}/field-composition

Lists every collection field that isn’t archived, with its id, its code and whether you may read its values. It returns no values; use it with GET /collections/{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. Collections have no team, so a capability granted for a team doesn’t count here. The collection isn’t looked up, so every id, including one that matches no collection, gets the same answer. Entries are sorted by code, and they say nothing about whether you may edit a value.

id
required
string format: uuid

The collection’s id.

One entry per collection 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