List artifacts

GET

/v1/artifacts

const url = 'https://shareout.site/v1/artifacts?limit=50&offset=0';
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://shareout.site/v1/artifacts?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

favorites

boolean

Return only the current user’s favorited artifacts.

workspace_id

string

List artifacts that belong to a workspace (not the caller’s personal artifacts). Caller must be a workspace member (403 otherwise). Owners/admins see all workspace artifacts; members see non-private artifacts plus any they own or collaborate on.

limit

integer

default: 50 <= 100

offset

integer

count

boolean

Set true to include an exact total (extra query).

Responses

200

A list of artifacts

application/json

object

artifacts

Array<object>

object

string

name

string

slug

string

visibility

‘unlisted’ was retired 2026-07 — still accepted as input and treated as ‘public’.

string

Allowed values: public workspace private

moderation_status

Safety review state for open visibility.

string

Allowed values: approved pending blocked

allow_anon_write

boolean

allow_anon_email

boolean

allow_anon_agent

boolean

allow_anon_collab

boolean

url

string format: uri

thumbnail_url

string | null format: uri

workspace_id

string | null

artifact_type

string

paused

boolean

current_version

Version_no live on the production deployment (reflects rollback).

integer

live_message

Change note of the live version (detail endpoint only).

string | null

live_message_source

author when the publisher wrote live_message, ai when it was generated (detail endpoint only).

string | null

Allowed values: author ai

user_role

Caller’s role (list endpoint only).

string

can_edit

Caller may update the artifact and use the editor (detail endpoint only).

boolean

can_delete

Caller may move the artifact to Trash (detail endpoint only).

boolean

can_manage_comments

Caller may change the artifact’s comment settings, such as guest comments (owner; detail endpoint only).

boolean

pages

HTML pages of the live version, entrypoint first (detail endpoint only; present when there are 2+).

Array<string>

entrypoint

The live version’s entrypoint (detail endpoint only; present with pages).

string

is_favorite

boolean

created_at

string format: date-time

updated_at

string | null format: date-time

has_more

boolean

total

Only with count=true.

integer

limit

integer

offset

integer

Example

{
  "artifacts": [
    {
      "visibility": "public",
      "moderation_status": "approved",
      "live_message_source": "author"
    }
  ]
}

401

Authentication required

application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}

403

Access denied

application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}