Get a share

getShare

GET /api/v1/shares/{share_id}

Scope: foldr.readRate cost: 1

One of the person’s shares, by id

A share that does not exist and one that is not the person’s get the same 404.

Request

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

Responses

Status	Meaning	Body
200	The Share.	application/json: Share

200 response

Share:

Field	Type	Description
id	string (uuid)	Required. The share’s id. Always a uuid.
name	string	Required. The share’s name, as people see it in Foldr.
type	string	Required. The kind of storage behind the share. New values may appear: treat an unknown one as “other”. Known values: smb, local, hosted, s3, b2, azure_blob, sftp, ftp, webdav, edge, google_drive, google_shared_drive, group_drive, onedrive, sharepoint, teams, dropbox, box, other. Clients must accept values not listed here.
indexed	boolean	Required. Whether the share is indexed for GET /search.
read_only	boolean	Required. True when the person cannot change anything in the share.
reachable	boolean	Required. False when the share’s file server could not be reached just now. It still exists and is the person’s: try again in a few minutes.

Example:

{
  "id": "0191f2c4-8a1e-7b52-9d3a-5c1e0b7a4d21",
  "name": "string",
  "type": "string",
  "indexed": false,
  "read_only": false,
  "reachable": 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).
404	not-found	Not found (not-found).
429	rate-limited	Too many requests (rate-limited).
500	internal-error	Internal error (internal-error).