Files

Get Many Files

Get multiple files with pagination and filtering

GET
/shipos/files
x-access-token<token>

In: header

Query Parameters

page?number

Page number for pagination (starting from 0)

Formatdouble
Default0
limit?number

Number of items per page

Formatdouble
Default20
search?string

Search term to filter files by name

Default""
mimetype?string

Filter by MIME type (comma-separated for multiple)

Default""
min_size?number

Filter files with minimum size in bytes

Formatdouble
Defaultnull
order_by?string

Field to order results by

Default"created_at"

Value in

  • "created_at"
  • "updated_at"
  • "name"
  • "size"
order?string

Order direction

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/shipos/files"
{  "data": [    {      "tags": [        "string"      ],      "team_id": "string",      "processing_status": "PENDING",      "description": "string",      "file_category": "DOCUMENT",      "preview_blur_hash": "string",      "thumbnail_url": "string",      "size": 0.1,      "mimetype": "string",      "url": "string",      "name": "string",      "updated_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "supported_actions": [        {          "action": "VIEW_FILE"        }      ]    }  ],  "meta": {    "page": 0.1,    "page_size": 0.1,    "has_next_page": true,    "has_previous_page": true,    "start_index": 0.1,    "end_index": 0.1  }}