Skip to content

Get a sharing request

getShareRequest

GET /api/v1/share-requests/{id}

Scope: sharingRate cost: 1

One of the person’s own sharing requests, as it stands now

Another person’s, or one that does not exist, is the same 404.

Terminal window
curl "$FOLDR/api/v1/share-requests/$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.

NameInTypeRequiredDescription
idpathstringYesThe request’s id.
StatusMeaningBody
200The ShareRequest.application/json: ShareRequest

ShareRequest:

FieldTypeDescription
idstring (uuid)Required. The request’s id.
share_idstring (uuid)Required. The id of the share the item is in.
pathstringRequired. The item’s canonical path.
kindstringRequired. What was asked for. Known values: people, public_link, secure_link, inbox. Clients must accept values not listed here.
statusstringRequired. Where it stands: pending_approval until an approver decides; approved; declined (by an approver, or left undecided until it lapsed); withdrawn. Known values: pending_approval, approved, declined, withdrawn. Clients must accept values not listed here.
created_atstring or null (date-time)Required. When it was asked for (RFC 3339, UTC).
decided_atstring or null (date-time)Required. When it was decided, or null while it waits.

Example:

{
"id": "0191f2c4-8a1e-7b52-9d3a-5c1e0b7a4d21",
"share_id": "0191f2c4-8a1e-7b52-9d3a-5c1e0b7a4d21",
"path": "string",
"kind": "string",
"status": "string",
"created_at": "2026-11-04T09:30:00Z",
"decided_at": "2026-11-04T09:30:00Z"
}

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

StatusProblem typesWhen
400invalid-requestInvalid request (invalid-request).
401invalid-tokenInvalid token (invalid-token).
403insufficient-scopeInsufficient scope (insufficient-scope).
404not-foundNot found (not-found).
429rate-limitedToo many requests (rate-limited).
500internal-errorInternal error (internal-error).