List shares visible to the authenticated account.

GET

/v1/shares

const url = 'https://api.share2.us/v1/shares?status=created&limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.share2.us/v1/shares?status=created&limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

Parameters

Query Parameters

status

string

Allowed values: created uploading uploaded scanning ready expired revoked blocked deleted

limit

integer

default: 50 >= 1 <= 100

cursor

string

Responses

200

Shares page.

application/json

object

shares

required

Array<object>

object

required

string

public_id

required

string

>= 12 characters

url

required

string format: uri

filename

required

string

size_bytes

required

integer format: int64

content_class

string

Allowed values: text image document archive binary

state

required

string

Allowed values: created uploading uploaded scanning ready expired revoked blocked deleted

download_count

integer

max_downloads

integer

>= 1

password_protected

boolean

recipient_restricted

What the share ACTUALLY is. On the create response this is what lets a client that asked for visibility: private tell it got one: an older server ignores the field and returns a 201 with a PUBLIC link, so an ABSENT value must be read as “unknown”, never as false.

boolean

encrypted

boolean

scan_status

Malware scan outcome. skipped means the file was not scanned (scanning off, encrypted, or scanner unavailable) and is served with a visible warning; only a real dirty verdict blocks a share (ADR-013).

string

Allowed values: pending clean blocked skipped

expires_at

required

string format: date-time

created_at

required

string format: date-time

next_cursor

string | null

Example

{
  "shares": [
    {
      "content_class": "text",
      "state": "created",
      "scan_status": "pending"
    }
  ]
}

default

Standard error envelope.

application/json

object

error

required

object

code

required

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "code": "quota_exceeded"
  }
}