List files

GET/v5/files

List the account’s files with pagination.

Optionally filter by filename (case-insensitive partial match). Results are scoped to the files the caller is authorized to read. Files marked hidden (internal or service-owned artifacts) are excluded from this listing but remain retrievable by id. Returns file metadata only, not content.

Query ParametersExpand Collapse

ending_before: optional string

filename: optional string

Filter files by filename (case-insensitive partial match)

limit: optional number

maximum10000

minimum1

sort_by: optional string

sort_order: optional SortOrder

One of the following:

"asc"

"desc"

starting_after: optional string

Header ParametersExpand Collapse

"x-project-id": optional string

ReturnsExpand Collapse

has_more: boolean

Whether there are more items left to be fetched.

items: array of SGPFile { id, created_at, created_by, 7 more }

id: string

The unique identifier of the entity.

created_at: string

The date and time when the entity was created in ISO format.

formatdate-time

created_by: Identity { id, type, object }

The identity that created the entity.

id: string

type: "user" or "service_account"

One of the following:

"user"

"service_account"

object: optional "identity"

filename: string

md5_checksum: string

mime_type: string

size: number

duration_seconds: optional number

object: optional "file"

tags: optional map[unknown]

total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: optional number

The maximum number of items to return.

object: optional "list"

List files

curl https://api.egp.scale.com/v5/files \
    -H "x-api-key: $SGP_API_KEY"

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "filename": "filename",
      "md5_checksum": "md5_checksum",
      "mime_type": "mime_type",
      "size": 0,
      "duration_seconds": 0,
      "object": "file",
      "tags": {
        "foo": "bar"
      }
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Returns Examples

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "filename": "filename",
      "md5_checksum": "md5_checksum",
      "mime_type": "mime_type",
      "size": 0,
      "duration_seconds": 0,
      "object": "file",
      "tags": {
        "foo": "bar"
      }
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}