Skip to content
Speccy

List the files of a bundle version. The default is the current version.

GET
/docs/{docId}/files
curl --request GET \
  --url https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/files

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
docId
required
string format: uuid

The ID of one spec doc.

Query Parameters

Section titled “Query Parameters”
version
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

The files, sorted by path.

Media typeapplication/json
object
version
required
object
id
required
string format: uuid
number
required
integer format: int64
created_by
required
string
message
required
string
created_at
required
string format: date-time
items
required
Array<object>
object
path
required
string
carried_by

The doc whose reference brought this file in. A carried file is read only.

string
size
required
integer format: int64
sha256
required
string
is_main_doc
required
boolean
Examplegenerated
{
  "version": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "number": 1,
    "created_by": "example",
    "message": "example",
    "created_at": "2026-04-15T12:00:00Z"
  },
  "items": [
    {
      "path": "example",
      "carried_by": "example",
      "size": 1,
      "sha256": "example",
      "is_main_doc": true
    }
  ]
}

default

Section titled “default”

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}