sharing

Get all link shares for a project

Returns all link shares which exist for a given project

get/projects/{project}/shares

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/projects/{project}/shares
  • Auth
    API key in header Authorization

Path parameters

projectinteger required

Project ID

Query parameters

pageinteger

The page number. Used for pagination. If not provided, the first page of results is returned.

per_pageinteger

The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.

sstring

Search shares by hash.

Response

The share links

createdstring

A timestamp when this project was shared. You cannot change this value.

hashstring

The public id to get this shared project

idinteger

The ID of the shared thing

namestring

The name of this link share. All actions someone takes while being authenticated with that link will appear with that name.

passwordstring

The password of this link share. You can only set it, not retrieve it after the link share has been created.

permission0 | 1 | 2
sharing_type0 | 1 | 2
updatedstring

A timestamp when this share was last updated. You cannot change this value.

Changes

No recorded changes to this operation across all 74 revisions of this API.