List shares

listShares

GET /api/v1/shares

Scope: foldr.readRate cost: 1

List the shares the person can read

Shares whose file server is down just now are listed with reachable false, after the rest. Shares that only open with the person’s own password are not listed: a token carries none.

Request

curl "$FOLDR/api/v1/shares" \
  -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
cursor	query	string	No	From a previous page’s next_cursor.
limit	query	integer	No	Shares per page, from 1: default 100; more than 200 is read as 200. 0 is refused.

Responses

Status	Meaning	Body
200	One page of Shares.	application/json: SharePage

200 response

SharePage:

Field	Type	Description
items	array of Share	Required. This page’s entries.
next_cursor	string or null	Required. The cursor for the next page, or null when this is the last.
truncated	boolean	Required. True when the collection holds more than one listing can read (a folder of more than 25,000 entries): the pages give the first 25,000 the storage lists, and every page of it says true, so a null next_cursor is not the whole folder. False otherwise.

Example:

{
  "items": [
    {
      "id": "0191f2c4-8a1e-7b52-9d3a-5c1e0b7a4d21",
      "name": "string",
      "type": "string",
      "indexed": false,
      "read_only": false,
      "reachable": false
    }
  ],
  "next_cursor": "string",
  "truncated": 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-cursor invalid-request	One of: Invalid cursor (invalid-cursor); Invalid request (invalid-request).
401	invalid-token	Invalid token (invalid-token).
403	insufficient-scope	Insufficient scope (insufficient-scope).
410	cursor-expired	Cursor expired (cursor-expired).
429	rate-limited	Too many requests (rate-limited).
500	internal-error	Internal error (internal-error).