Skip to content
ParseHawkParseHawk Developer Docs

List files

GET
/v1/files
curl --request GET \
  --url http://127.0.0.1:8000/v1/files

List metadata for every uploaded and built-in example file.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Listfiles
Array<object>
FileResponse

Metadata for a file stored by ParseHawk.

object
id
required
Id

Immutable file identifier.

string
file_name
required
File Name

Original upload filename.

string
content_type
required
Content Type

Detected or supplied media type.

string
size_bytes
required
Size Bytes

Stored file size in bytes.

integer
sha256
required
Sha256

Lowercase SHA-256 digest of the stored bytes.

string
source
required
FileSource

How the file entered ParseHawk.

string
Allowed values: user example
is_example
required
Is Example

Whether the file ships as a built-in example.

boolean
created_at
required
Created At

UTC creation time.

string format: date-time
Example
[
  {
    "id": "file_01JZ6QK8M7",
    "file_name": "invoice.pdf",
    "content_type": "application/pdf",
    "source": "user"
  }
]

500

Section titled “500”

Unexpected server error.

Media typeapplication/json
ApiErrorResponse

Error returned by request validation or a ParseHawk domain service.

object
detail
required
Any of:
string
Examplegenerated
{
  "detail": [
    {}
  ]
}