List Files

GET 
/files

Retrieves a paginated list of all files uploaded by the client or user

Request

Query Parameters

limit string

Default value: 50

GET /files parameter

page string

Default value: 1

The page of agreements to return. Default 1

order_by string

Possible values: [desc, asc]

The files are ordered by date in descending order by default.

start_date date-time

Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$

The earliest creation date of the files to return.

end_date date-time

Possible values: Value must match regular expression ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$

The latest creation date of the files to return.

mime_type string

Possible values: [application/pdf, image/png, image/jpg]

Filters the file list for the specific mimetype.

lookup_key string

The lookup key of the files to return

Responses

200

GET /files Successful response

application/json

Schema

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [paginated_list]

A paginated list of the file resource.

resource_type stringrequired

Possible values: [file]

Data contains the file resource.

data object[]required
The resource data
Array [
id cuidrequired
The unique identifier of the file
resource_type stringrequired
Possible values: [file]
filename stringrequired
Possible values: non-empty
The complete filename including the file extension
mime_type stringrequired
Possible values: non-empty
The mime type of the file
url url
The signed read url of the file
metadata object
lookup_key stringrequired
A provided lookup key provided by you to help you identify the file.
created_at stringrequired
UTC datetime ISO string
updated_at stringrequired
UTC datetime ISO string
]
pagination objectrequired

Contains the pagination meta data

limit int64required

Possible values: <= 9007199254740991

The maximum number of items per page

total_pages int64required

Possible values: <= 9007199254740991

The total number of pages

page int64required

Possible values: <= 9007199254740991

The current page number

total_results int64required

Possible values: <= 9007199254740991

The total number of results

Example (from schema)

{
  "version": "1.0",
  "result_type": "paginated_list",
  "resource_type": "file",
  "data": [
    {
      "id": "caujbc8v5idcecxuvwtexample",
      "resource_type": "file",
      "filename": "my-file.pdf",
      "mime_type": "application/pdf",
      "url": "https://zigned.se",
      "metadata": {
        "lookup_key": "file_tag"
      },
      "created_at": "2024-05-10T12:45:39.352Z",
      "updated_at": "2024-05-10T12:45:39.352Z"
    }
  ],
  "pagination": {
    "limit": 100,
    "total_pages": 10,
    "page": 1,
    "total_results": 1000
  }
}

400

GET /files Error response

application/json

Schema

Schema

status stringrequired

Possible values: [error]

error objectrequired
code int64required
Possible values: >= 400 and <= 599
message stringrequired
request_id uuidrequired

Example (from schema)

{
  "status": "error",
  "error": {
    "code": 0,
    "message": "string",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Loading...