Get a list of all resources

v1.0.0

Returns a list of files and folders in the account. Use the resource query parameter to indicate the folder you wish to search in (which can be /).

Searching for Files and Folders

Using the name parameter triggers search mode, which will search the entire directory structure under the provided resource for files or folders with names matching the provided name. This supports wildcard matching such as:

*Report* would find any files or folders with "Report" in the name.
Data_202?-09-30.xlsx would match items such as "Data_2020-09-30.xlsx", "DATA_2021-09-30.xlsx", "data_2022-09-30.xlsx" etc.
sales* would find any files or folders starting with the word "Sales"
*.csv would locate any files ending in ".csv"
* matches everything within the directory tree starting at your given resource

The search is not case-sensitive. Searching for Clients* or clients* or CLIENTS*, etc. will provide identical results

If you are using the name parameter to run a search, the type parameter will be ignored by the server.

Input

{
  "type": "object",
  "properties": {
    "ev-access-token": {
      "type": "string"
    },
    "ev-api-key": {
      "type": "string"
    },
    "include": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": "string"
    },
    "offset": {
      "type": "integer",
      "format": "int32"
    },
    "resource": {
      "type": "string"
    },
    "sort": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "ev-access-token",
    "ev-api-key",
    "resource"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Response object for collection of resources.",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "All properties of the resource.",
        "properties": {
          "attributes": {
            "type": "object",
            "description": "Attributes of resource",
            "properties": {
              "accessedAt": {
                "type": "string",
                "format": "date-time",
                "description": "Date-time of the time when resource was accessed."
              },
              "accessedTime": {
                "type": "integer",
                "format": "int32",
                "description": "UNIX timestamp of last access"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "description": "Date-time of resource creation."
              },
              "createdBy": {
                "type": "string",
                "description": "Username of the creator."
              },
              "createdTime": {
                "type": "integer",
                "format": "int32",
                "description": "UNIX timestamp of resource creation"
              },
              "extension": {
                "type": "string",
                "description": "Resource extension. Property exists only if resource `type` is file."
              },
              "fileCount": {
                "type": "integer",
                "description": "Number of files within folder. null if resource type is a file."
              },
              "hash": {
                "type": "string",
                "description": "Unique hash of the resource."
              },
              "name": {
                "type": "string",
                "description": "Resource name, e.g. the name of the file or folder."
              },
              "path": {
                "type": "string",
                "description": "Full path to the resource."
              },
              "previewable": {
                "type": "boolean",
                "description": "Can resource be previewed. Property equals `null` if resource `type` is dir.",
                "enum": [
                  true,
                  false
                ]
              },
              "size": {
                "type": "integer",
                "format": "int64",
                "description": "Resource size in bytes"
              },
              "type": {
                "type": "string",
                "description": "Type of the resource.",
                "enum": [
                  "file",
                  "dir"
                ]
              },
              "updatedAt": {
                "type": "string",
                "format": "date-time",
                "description": "Date-time of resource modification."
              },
              "updatedTime": {
                "type": "integer",
                "format": "int32",
                "description": "UNIX timestamp of resource modification"
              },
              "uploadDate": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp of resource upload."
              }
            }
          },
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "relationships": {
            "type": "object",
            "properties": {
              "directFile": {
                "type": "object",
                "properties": {
                  "data": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "format": "int32"
                      },
                      "type": {
                        "type": "string"
                      }
                    }
                  }
                }
              },
              "notifications": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "type": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              },
              "parentResource": {
                "type": "object",
                "properties": {
                  "data": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "format": "int64"
                      },
                      "type": {
                        "type": "string"
                      }
                    }
                  }
                }
              },
              "share": {
                "type": "object",
                "properties": {
                  "data": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "integer",
                        "format": "int32"
                      },
                      "type": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          },
          "type": {
            "type": "string",
            "description": "Type of item. \"resource\"",
            "enum": [
              "resource"
            ]
          }
        }
      }
    },
    "included": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "responseStatus": {
      "type": "integer",
      "description": "Http status code of the response."
    },
    "returnedResults": {
      "type": "integer",
      "description": "Count of returned results."
    },
    "totalResults": {
      "type": "integer",
      "description": "Total count of results found."
    }
  }
}