GET
/
files
/
{network}
List Files
curl --request GET \
  --url https://api.pinata.cloud/v3/files/{network} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "files": [
      {
        "id": "e5323ea7-8a02-4486-9b6f-63c788810aeb",
        "name": "e093dbd3-f276-4bb3-a43e-60437725f410.txt",
        "cid": "bafkreicnu2aqjkoglrlrd65giwo4l64pdajxffk6jtq2vb7yaiopc3yu7m",
        "size": 36,
        "number_of_files": 1,
        "mime_type": "text/plain",
        "group_id": "18893556-de8e-4229-8a9a-27b95468dd3e",
        "keyvalues": {
          "whimsey": "true"
        },
        "created_at": "2024-08-27T14:57:51.485934Z"
      }
    ],
    "next_page_token": "MDE5MTk0NTctYzJjNi03NzBlLTkzOTEtOGM3MmM0ZjQxZjY0"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
network
enum<string>
required

Target either the public or private IPFS network

Available options:
public,
private

Query Parameters

​
name
string

Filter files by name

​
group
string

Filter fils by group_id. Pass null to show files that are not part of a group

​
mimeType
string

Filter files by mime_type

​
cid
string

Filter files by CID

​
cidPending
boolean

Return only files that are still waiting for a CID

​
metadata
object

Filter by key values in file metadata

​
limit
integer

Limit the number of results

​
order
enum<string>

Sort results by creation date with with ASC or DESC

Available options:
ASC,
DESC
​
pageToken
string

Paginate using the nextPageToken

Response

200 - application/json

OK

The response is of type object.