List published versions

GET

/v1/artifacts/{id}/versions

const url = 'https://shareout.site/v1/artifacts/example/versions';
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/example/versions \
  --header 'Authorization: Bearer <token>'

The 50 newest published versions, newest first, with who published each one, how (source), its change note (message / message_source), the size of its entrypoint, how many comment threads were written on it and who approved it. live_version_id is the version production serves. Viewer or above.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

Artifact ID (e.g. art_abc123).

Responses

200

Versions

application/json

object

versions

Array<object>

object

string

version_no

integer

entrypoint

string

created_at

string format: date-time

source

How the version came to be; null on versions written before it was recorded.

string | null

Allowed values: api agent editor restore

message

Change note.

string | null

message_source

author when the publisher wrote it, ai when generated after publish (may appear a few seconds later).

string | null

Allowed values: author ai

created_by_email

string | null

created_by_name

string | null

restored_from_version_no

integer | null

size_bytes

Size of the entrypoint file.

integer | null

comment_count

Comment threads written while this version was live.

integer

approvals

Array<object>

object

name

string | null

email

string | null

created_at

string format: date-time

live_version_id

string | null

Example

{
  "versions": [
    {
      "source": "api",
      "message_source": "author"
    }
  ]
}

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"
    ]
  }
}

404

Resource not found

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"
    ]
  }
}