1. Share links
Pibox public API
  • v1
    • Teams
      • Invite Member
      • Get File Statuses
      • Get Teams
    • Groups
      • Get Groups
      • Get Group Info
      • Create Group
    • Projects
      • Get Project Info
      • Create Project
      • Chat Message
      • Get Projects by Group
      • Get Non Group Projects
      • Get Chat History
    • Account
      • Get Account Info
    • Files
      • Find Files
      • Get File Info
      • Create Folder
      • Get Files by Folder
      • Get Folder URL
      • Update Folder Properties
      • Delete File
      • Upload from External Source
      • Generate Track Tags
      • File Upload
    • Tasks
      • Get Task Template
      • Load Tasks from Template
      • Get Tasks by Folder
      • Create Tasks
    • Webhooks
      • Create Webhook Endpoint
      • Get Webhook Endpoints
      • Delete Webhook Endpoint
  • Webhooks
    • file.uploaded
    • file.renamed
    • file.status_changed
    • task.closed
  • v2 (BETA)
    • AI agent
      • List the caller's scheduled agent tasks (soonest first)
      • Schedule the agent to run a task later (once / daily / weekly)
      • Cancel a scheduled agent task
      • List the caller's active event subscriptions (newest first)
      • Subscribe to a user event (agent reminds the caller when it fires)
      • Cancel an event subscription
    • Playlists
      • List the playlists in a team
      • Create a playlist in a team
      • Get a playlist, including its files
      • Rename a playlist
      • Delete a playlist
      • Add a file to a playlist
      • Remove a file from a playlist
    • Favorites & Recents
      • List the caller's favorites (pinned projects, groups and files)
      • Add a project, group or file to favorites
      • Remove a project, group or file from favorites
      • List items (files/projects) the caller recently accessed
    • Notifications
      • List the caller's notifications (newest first)
      • Mark a single notification as read
      • Mark all of the caller's notifications as read
      • Get the caller's unread-notification counter
    • File comments
      • Resolve a comment (or reopen it with resolved=false)
      • List a file's comments
      • Leave a comment
      • Mark a file's comments as read
      • Export a file's comments
      • Edit a comment
      • Delete a comment
      • Reply to a comment
      • Toggle like on a comment
    • Knowledge base
      • Search the Pibox Help Center
      • Get a Help Center article by id
      • Search the Pro Tools / audio-production knowledge base
    • Search
      • Global search
    • Accounts
      • Who am I (connection test)
      • Get an account profile (same organization)
    • Messages
      • Mark all messages in the project chat as read
      • Project chat history
      • Send a message (reply via parent_message_id)
      • Forward a message into this project
      • Edit a message
      • Delete a message
    • Metadata
      • Get a file's custom metadata field values
      • Set the value of a custom metadata field on a file
      • Get a team's metadata template
      • Get a file's metadata
      • Export a file's metadata (xlsx)
      • Export metadata for multiple files
    • Tasks
      • List task-list templates of a team
      • List tasks in a folder
      • Create tasks (inline list) or load from a template
      • Get a task
      • Update a task
      • Delete a task
      • Add items to a task
      • Delete a task item
    • Files
      • Upload a file from a URL, from inline text content, or a multipart body
      • Set (or clear) a file's review status
      • Set a free-form label on a file version
      • Upload a file (streamed binary body)
      • Find files in a team (optionally scoped to a group/project)
      • List a team's file-status options
      • List folder contents
      • Create a folder (mkdir) or import a file from a URL
      • Generate AI track tags for files
      • Filter-search files across the caller's projects (name fuzzy match + audio-metadata filters)
      • Batch get file info (incl. media metadata + AI tags)
      • Generate an XLSX report from structured sheets; returns a download URL
      • Get file info (incl. media metadata + AI tags)
      • Update file properties
      • Delete a file
      • Deep-link URL to a folder in the app
      • Resolve a file's download URL
      • List a file's versions
      • Copy a file into another folder
      • Move (or rename) a file
      • List the project's trash
      • Attach files to this one as its new versions
      • Detach a file from its version stack
      • Create a public share link for one or more files
      • Preview URLs (thumbnail / poster frame and playback copy)
      • Archive a file or folder (hidden from the everyday listing, kept with all data)
      • Bring an archived file or folder back
      • Restore a file or folder from the trash
      • Delete a trashed file forever
    • Projects
      • Get a project
      • Update a project (rename / avatar / pin / auto-forward)
      • Delete a project
      • List projects of a group
      • Create a project in a group
      • List team projects (non-grouped)
      • Create a project under a team
      • Add a member (by account_id) or invite one (by email)
      • Members across the team's projects
      • Remove a member from the project
      • Cancel a pending project invitation (by email)
      • Batch get project info
      • List ungrouped projects for one or more teams
      • List projects for one or more groups
      • Search projects by name (fuzzy), optionally scoped to a team/group
    • Groups
      • List groups of a team
      • Create a group in a team
      • Get a group
      • Update a group (rename / description / avatar)
      • Delete a group
      • Move an existing project into the group
      • Batch get group info
      • List groups for one or more teams
      • Search groups by name (fuzzy), optionally scoped to a team
    • Teams
      • Invite a member to a team
      • Workflow 'vision datapoints' for a team: current counts (open/done/overdue), throughput and on-time…
      • Summarise task & deadline progress across a whole team: overall counts (open, done, overdue,…
      • Caller's role capabilities and plan limits in a team (incl. remaining AI credits)
      • See recent file activity across a team - an 'is work actually happening' signal built from file…
      • List the caller's teams
      • Get a team (incl. members and pending members)
      • Add an existing account to the team
      • Change a member's role
      • Remove a member from the team
      • Cancel a pending invitation (by email)
      • AI credits usage statistics and history for the team's organization
    • OAuth
      • Authorization-server metadata (RFC 8414)
      • Consent page (issues an authorization code)
      • Confirm consent (api_token bridge) → 302 with code
      • Consent page for a signed-in user (return from the app)
      • Exchange code (PKCE) or refresh_token for tokens
      • Revoke an access or refresh token (RFC 7009)
      • Dynamic client registration (RFC 7591)
    • team
      • Get Teams (GET)
    • Media analysis
      • List the cuts made from a recording
      • Cut a range out of a recording into a new file
      • List clip candidates already proposed for a file, best first
      • Analyse a video or audio file's transcript and propose excerpts that would work as standalone short…
      • Check whether a video or audio file has been transcribed, and how far along it is
      • Transcribe a video or audio file so its speech can be searched
      • Analyse a video's frames so what is SHOWN on screen becomes searchable alongside what is said - slide…
      • Search recordings for the moments matching a prompt
    • Skills
      • List the available skills
      • Read one skill in full
    • Webhooks
      • Recent webhook events (sample data)
      • Create a webhook endpoint
      • List webhook endpoints
      • Delete a webhook endpoint
    • MCP servers
      • List the team's connected MCP servers
      • Connect an MCP server to the team
      • Try an MCP server before saving it
      • Update an MCP server
      • Disconnect an MCP server
      • Check a saved MCP server
    • Uploads
      • Start an upload session (resumable, parallel upload straight into storage)
      • Upload session status — what storage already holds
      • Cancel an upload session
      • Fresh presigned URLs for a range of parts
      • Complete the upload — turn the parts into a file
    • Share links
      • List share links
        GET
      • Create a share link
        POST
      • Get a share link
        GET
      • Change a share link
        PATCH
      • Delete a share link
        DELETE
      • Copy a share link
        POST
      • Replace the url of a share link
        POST
      • Invite people by email
        POST
      • Change what an invited person may do
        PATCH
      • Remove a person
        DELETE
      • Who opened, played and downloaded
        GET
  • Files
    • Read a file's content (text) or an AI description of it (image)
  • Schemas
    • v1
      • Team
      • Track Info
      • Video Info
      • Image Info
      • AI Tags
      • Empty Schema
    • ShareLinkFields
    • FileStatus
    • Error
    • UploadSession
    • ListEnvelope
    • ObjectEnvelope
    • ShareLinkPerson
    • TokenResponse
    • ClientRegistration
    • AuthServerMetadata
    • UploadPart
    • ShareLink
  1. Share links

Get a share link

GET
https://api.pibox.com/api/v2/share-links/{shareId}
Scope: files:read
Settings, people and statistics. The password itself is never returned.

Request

Authorization
OAuth 2.0
Authorization Code
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Authorize URL: https://api.pibox.com/api/v2/oauth/authorize
Token URL: https://api.pibox.com/api/v2/oauth/token
Refresh URL: /api/v2/oauth/token
or
Path Params

Responses

🟢200OK
application/json
A share link
Bodyapplication/json

🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.pibox.com/api/v2/share-links/' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Example 1
{
    "object": "share_link",
    "data": {
        "share_id": "string",
        "url": "string",
        "name": "string",
        "created_at": "2019-08-24T14:15:22.123Z",
        "source": {
            "kind": "string",
            "project_id": 0,
            "file_id": 0,
            "playlist_id": 0
        },
        "access": "string",
        "right": "string",
        "download": true,
        "expires_at": "string",
        "password": {
            "enabled": true,
            "for_invited": true
        },
        "people": [
            {}
        ],
        "content": {},
        "page": {},
        "embed": {},
        "notify_owner": true,
        "stats": {}
    }
}
Modified at 2026-11-06 14:23:20
Previous
Create a share link
Next
Change a share link
Built with