PilotFoxDocs

List share links

GET
/api/v1/sites/{siteId}/share-links

The site's share links that are not revoked (expired ones included), newest first, with their scopes, expiry and last use; never the tokens: tokenPrefix is their start.

Requires shareLink:read on the site (an API key, or a signed-in member's role). Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: shareLink:read

Path Parameters

siteId*string

Response Body

OK

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://pilotfox.app/api/v1/sites/string/share-links'
Example Response200
{  "data": [    {      "id": "string",      "name": "string",      "tokenPrefix": "string",      "scopes": [        "string"      ],      "expiresAt": "2019-08-24T14:15:22Z",      "lastUsedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z"    }  ]}