Skip to main content
GET
/
api
/
v1
/
:team_slug
/
:app_slug
/
files
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "attributes": [
        {
          "created_at": "<string>",
          "description": "<string>",
          "filterable": true,
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "template_key": "<string>",
          "template_name": "<string>",
          "translatable": true,
          "translations": {
            "description": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ],
            "name": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ]
          },
          "updated_at": "<string>",
          "values": {}
        }
      ],
      "created_at": "<string>",
      "folder_id": "<string>",
      "id": "<string>",
      "title": "<string>",
      "translations": {
        "title": [
          {
            "id": "<string>",
            "locale": "<string>",
            "omni_channel_translations": [
              {
                "id": "<string>",
                "market_id": "<string>",
                "store_group_id": "<string>",
                "value": "<string>"
              }
            ],
            "value": "<string>"
          }
        ],
        "type": [
          {
            "id": "<string>",
            "locale": "<string>",
            "omni_channel_translations": [
              {
                "id": "<string>",
                "market_id": "<string>",
                "store_group_id": "<string>",
                "value": "<string>"
              }
            ],
            "value": "<string>"
          }
        ]
      },
      "type": "<string>",
      "updated_at": "<string>",
      "url": "<string>"
    }
  ],
  "success": true,
  "total": 123,
  "total_pages": 123
}

Path Parameters

app_slug
string
required

App slug

team_slug
string
required

Team slug

Query Parameters

sort-order
string

Sort order. Should be one of ASC or DESC. Default DESC

sort-key
string

The key to sort on. Can be one of title, type, created_at, updated_at (Default is created-at)

Response

Files retrieved successfully

data
object[]
success
boolean
total
integer
total_pages
integer