Get files CDN

Get cdn items

get

Query parameters

UserIdstringOptional

The id of the user.

RefObjectstringOptional

The reference object for filter.

RefIdinteger · int64Optional

The reference identifier for filter.

MimeTypestringOptional

The MIME Type for filter.

OriginalFilenamestringOptional

The original file name for filter.

SortDataFieldstringOptional

The sort data field of the pagination.

SortOrderstringOptional

The sort order of the pagination.

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/cdn HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "user": {
          "id": "Plamxinzg18snza",
          "code": "EXAMPLE",
          "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
          "packageId": "1Plamxinzg18snza",
          "packageCode": "PACKAGE",
          "emailAddress": "[email protected]",
          "nickName": "example",
          "roles": [
            "admin",
            "support"
          ]
        },
        "refObject": "Object",
        "refId": 1,
        "mimeType": "image/png",
        "fileURL": "https://cdn.jframework.io/uploads/documents/example.pdf",
        "originalFilename": "image.png",
        "notes": "Notes",
        "tags": "Tags",
        "zOrder": 1,
        "isSystem": false,
        "createdDate": "2025-06-23T13:56:00.3842968+07:00"
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}