| Target URL | /api.php/Drive/files/metadata/fields |
| Required scope | metadata |
| HTTP Method | GET/POST |
| Output format | JSON |
This endpoint takes no parameters.
Since FileRun 2026.3.0 it requires the metadata scope and the account permission to access metadata. Before, any access token was accepted.
The fields array holds the definitions of the user-defined metadata fields. The system fields (the ones behind the tags, the stars, the comments and so on) are left out. Each entry has the following fields:
| Field | Type | Description |
|---|---|---|
| id | integer | The field id, which Setting metadata takes as the key of the fields parameter |
| fsid | integer | The id of the field set (the metadata file type, such as Documents or Photos) the field belongs to |
| name | string | |
| description | string | |
| type | string | The type of the field |
| autocomplete | boolean (1/0) or null | |
| options | string | The options of the field, for the types which have them |
| hide_field_via_weblinks | boolean (1/0) | |
| show_column_by_default | boolean (1/0) | |
| system | boolean (1/0) | Always 0, the system fields being left out |
| source | string or null | |
| sort | integer or null |