List custom fields

listFields

GET /api/v1/fields

Scope: foldr.readRate cost: 1

The custom fields the person can see, across their shares

Request

curl "$FOLDR/api/v1/fields" \
  -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.

Responses

Status	Meaning	Body
200	Every matching Field.	application/json: array of Field

200 response

A JSON array of Field.

Field	Type	Description
id	string (uuid)	Required. The field’s id. Always a uuid.
name	string	Required. The field’s name.
type	string	Required. What kind of value it holds. New values may appear. Known values: string, text, number, bool, date, location, select, signature, delegate. Clients must accept values not listed here.
options	array or null	Required. The values it may take, where it has a fixed list (on at least one of the person’s shares); otherwise null.
multiple	boolean	Required. Whether a file can carry more than one value of it.
read_only	boolean	Required. True when the person may not set it on any of their shares.

Example:

[
  {
    "id": "0191f2c4-8a1e-7b52-9d3a-5c1e0b7a4d21",
    "name": "string",
    "type": "string",
    "options": [
      "string"
    ],
    "multiple": false,
    "read_only": false
  }
]

Errors

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

Status	Problem types	When
400	invalid-request	Invalid request (invalid-request).
401	invalid-token	Invalid token (invalid-token).
403	insufficient-scope	Insufficient scope (insufficient-scope).
429	rate-limited	Too many requests (rate-limited).
500	internal-error	Internal error (internal-error).