Skip to main content
GET
/
v1
/
files
Get files
curl --request GET \
  --url https://api.hyperline.co/v1/files \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0,
    "approximateCount": false
  },
  "data": [
    {
      "id": "fil_2QdJDDUej969ev",
      "name": "invoice_2024.pdf",
      "type": "pdf",
      "mimetype": "application/pdf",
      "customer_id": "cus_QalW2vTAdkR6IY",
      "created_at": "2024-11-12T07:38:39.222Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
name
string
​
name__not
string
​
name__isNull
string
​
name__isNotNull
string
​
name__equals
string
​
name__contains
string
​
name__startsWith
string
​
name__endWith
string
​
customer_id
string
​
customer_id__not
string
​
customer_id__isNull
string
​
customer_id__isNotNull
string
​
customer_id__equals
string
​
customer_id__contains
string
​
customer_id__startsWith
string
​
customer_id__endWith
string
​
take
number | null
default:50
Required range: 0 <= x <= 100
​
skip
number | null
default:0
Required range: x >= 0

Response

200 - application/json
​
meta
object
required
​
data
object[]
required

List of File.