Get field values

getFieldValues

GET /api/v1/shares/{share_id}/field-values

Scope: foldr.readRate cost: 1

The custom field values on one file or folder

A field that holds several values appears once per value. The ETag header covers the whole set; send it back as If-None-Match for a 304 while nothing has changed.

Request

curl "$FOLDR/api/v1/shares/$SHARE_ID/field-values" \
  -H "Authorization: Bearer $TOKEN"

$FOLDR is your site’s address (for example https://files.example.com) and $TOKEN is an access token. See Getting access.

Parameters

Name	In	Type	Required	Description
`share_id`	path	string	Yes	The share’s id.
`path`	query	string	No	Path of the file or folder.

Responses

Status	Meaning	Body
200	Every matching FieldValue.	`application/json`: array of FieldValue
304	If-None-Match named the values as they are now.	none

200 response

Header	Description
`ETag`	The entity tag of what was answered. Send it back as If-None-Match for a 304 while it is unchanged, or as If-Match to change it only while it is unchanged.

A JSON array of FieldValue.

Field	Type	Description
`field_id`	string (uuid)	Required. The field’s id (see GET /fields).
`value`	any	Required. The value: a string, number or boolean by the field’s type; a location is an object.
`updated_at`	string or null (date-time)	Required. When it was last set (RFC 3339, UTC).
`updated_by`	Person or null	Required. Who last set it, where known.

Example:

[
  {
    "field_id": "0191f2c4-8a1e-7b52-9d3a-5c1e0b7a4d21",
    "value": "string",
    "updated_at": "2026-11-04T09:30:00Z",
    "updated_by": {
      "id": "string",
      "name": "string"
    }
  }
]

304 response

Header	Description
`ETag`	The entity tag of what was answered. Send it back as If-None-Match for a 304 while it is unchanged, or as If-Match to change it only while it is unchanged.

Errors

Every error is an application/problem+json document (ProblemDetails); branch on its type or code. See Errors.

Status	Problem types	When
400	`invalid-path` `invalid-request`	One of: Invalid path (invalid-path); Invalid request (invalid-request).
401	`invalid-token`	Invalid token (invalid-token).
403	`insufficient-scope`	Insufficient scope (insufficient-scope).
404	`not-found`	Not found (not-found).
409	`ambiguous-path` `approved-version-unavailable` `storage-account-not-connected`	One of: Ambiguous path (ambiguous-path); Approved version unavailable (approved-version-unavailable); Storage account not connected (storage-account-not-connected).
429	`rate-limited`	Too many requests (rate-limited).
500	`internal-error`	Internal error (internal-error).
503	`share-unavailable` `share-unreachable`	One of: Share unavailable (share-unavailable); Share unreachable (share-unreachable).