Review state of an artifact

GET

/v1/home/review

curl --request GET \
  --url 'https://shareout.site/v1/home/review?artifactId=example' \
  --header 'Authorization: Bearer <token>'

• Production

The live version, whether the caller may review (resolve, assign, approve) and every approval. The Home shell’s endpoint; accepts a session cookie or a Bearer token. Comments themselves are read and resolved through the Data comments endpoints.

Authorizations

• bearerAuth

Parameters

Query Parameters

artifactId

required

string

Responses

200

Review state

Media typeapplication/json

object

live_version_id

string | null

live_version_no

integer | null

can_review

Caller may resolve, assign and approve.

boolean

approvals

Array<object>

object

version_id

string

version_no

integer

user_id

string

name

string | null

email

string | null

created_at

string format: date-time

my_approvals

Version ids the caller (any linked account) approved.

Array<string>

Example^generated

{
  "live_version_id": "example",
  "live_version_no": 1,
  "can_review": true,
  "approvals": [
    {
      "version_id": "example",
      "version_no": 1,
      "user_id": "example",
      "name": "example",
      "email": "example",
      "created_at": "2026-04-15T12:00:00Z"
    }
  ],
  "my_approvals": [
    "example"
  ]
}

400

Invalid request

Media typeapplication/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

No access to this artifact