Skip to main content
GET
/
v1
/
objects
JavaScript
import Runloop from '@runloop/api-client';

const client = new Runloop({
  bearerToken: 'My Bearer Token',
});

// Automatically fetches more pages as needed.
for await (const objectView of client.objects.list()) {
  console.log(objectView.id);
}
{
  "objects": [
    {
      "id": "<string>",
      "name": "<string>",
      "state": "UPLOADING",
      "size_bytes": 123,
      "content_type": "unspecified",
      "create_time_ms": 123,
      "delete_after_time_ms": 123,
      "upload_url": "<string>"
    }
  ],
  "has_more": true,
  "total_count": 123,
  "remaining_count": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer

The limit of items to return. Default is 20.

​
starting_after
string

Load the next page of data starting after the item with the given ID.

​
name
string

Filter storage objects by name (partial match supported).

​
content_type
enum<string>

Filter storage objects by content type.

Available options:
unspecified,
text,
binary,
gzip,
tar,
tgz
​
state
enum<string>

Filter storage objects by state.

Available options:
UPLOADING,
READ_ONLY,
DELETED,
ERROR
​
search
string

Search by object ID or name.

Response

Successfully retrieved list of Objects.

A paginated list of Objects.

​
objects
object[]
required

List of Object entities.

​
has_more
boolean
required

True if there are more results available beyond this page.

​
total_count
integer
required

Total number of Objects across all pages.

​
remaining_count
integer
required

Number of Objects remaining after this page.