Shares

Get share by ID

Return shares by UID

get/shares/{share_id}

Path parameters

share_idstring required

Unique identifier of the share.

Response

Share object

idstring required
namestring required
ownerstring required
allow_streamboolean required
allow_downloadboolean required
creation_dateinteger required
lastvisit_dateinteger required
object_typestring nullable required

The kind of object referenced, as a bare string. The set is intentionally open so a new media type is not a breaking change; values seen today include song, album, artist, playlist, podcast, podcast_episode and video.

object_idstring required
expire_daysinteger required
max_counterinteger required
counterinteger required
secretstring nullable required
public_urlstring nullable required
descriptionstring nullable required

Changes

Changed in 6 of the 46 revisions of this API.123

    • api operation id share was added

      api-operation-id-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 403

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added the non-success response with the status 500

      response-non-success-status-added

    • added the required property allow_download to the response with the 200 status

      response-required-property-added

    • added the required property allow_stream to the response with the 200 status

      response-required-property-added

    • added the required property counter to the response with the 200 status

      response-required-property-added

    • added the required property creation_date to the response with the 200 status

      response-required-property-added

    • added the required property description to the response with the 200 status

      response-required-property-added

    • added the required property expire_days to the response with the 200 status

      response-required-property-added

    • added the required property id to the response with the 200 status

      response-required-property-added

    • added the required property lastvisit_date to the response with the 200 status

      response-required-property-added

    • added the required property max_counter to the response with the 200 status

      response-required-property-added

    • added the required property name to the response with the 200 status

      response-required-property-added

    • added the required property object_id to the response with the 200 status

      response-required-property-added

    • added the required property object_type to the response with the 200 status

      response-required-property-added

    • added the required property owner to the response with the 200 status

      response-required-property-added

    • added the required property public_url to the response with the 200 status

      response-required-property-added

    • added the required property secret to the response with the 200 status

      response-required-property-added

    • removed the non-success response with the status 400

      response-non-success-status-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the non-success response with the status 400

      response-non-success-status-added

    • endpoint added

      endpoint-added

    • api path removed without deprecation

      api-path-removed-without-deprecation