Skip to content

Get artifact files

GET
/v1/artifacts/{id}/files
curl --request GET \
--url https://shareout.site/v1/artifacts/example/files \
--header 'Authorization: Bearer <token>'

Fetch all files for an artifact version. Requires viewer access or higher.

id
required
string

Artifact ID (e.g. art_abc123).

version
string

Version number or ID. Defaults to the latest.

Files for the version

Media typeapplication/json
object
artifact_id
string
version_id
string
files
Array<object>
object
path
required

Relative path with “/” between folders. No “..”, no leading “/”, no backslash, no empty or “.” segments (e.g. “a//b”, “./x”), no control characters, at most 512 characters. An unsafe path is rejected with 400 INVALID_PATH; the hint names it.

string
<= 512 characters
content
required
string
mime
string
encoding
string
Allowed values: utf8 base64
size_bytes
integer
Example
{
"files": [
{
"path": "img/logo@2x.png",
"encoding": "utf8"
}
]
}

Resource not found

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