# List catalog objects in a workspace

GET https://api.bctrl.ai/v1/storage/objects

Reference: https://platform.bctrl.ai/api/api-reference/storage/objects-list

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v1/storage/objects:
    get:
      operationId: objects-list
      summary: List catalog objects in a workspace
      tags:
        - subpackage_storage
      parameters:
        - name: workspace
          in: query
          required: true
          schema:
            type: string
        - name: runtimeId
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: source
          in: query
          required: false
          schema:
            type: string
        - name: driver
          in: query
          required: false
          schema:
            type: string
        - name: target
          in: query
          required: false
          schema:
            type: string
        - name: pathPrefix
          in: query
          required: false
          schema:
            type: string
        - name: limit
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/V1StorageObjectsGetParametersLimit'
        - name: offset
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/V1StorageObjectsGetParametersOffset'
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/storage_objectsList_Response_200'
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V1StorageObjectsGetParametersLimit:
      oneOf:
        - type: integer
        - type: string
      title: V1StorageObjectsGetParametersLimit
    V1StorageObjectsGetParametersOffset:
      oneOf:
        - type: integer
        - type: string
      title: V1StorageObjectsGetParametersOffset
    V1StorageObjectsGetResponsesContentApplicationJsonSchemaObjectsItems:
      type: object
      properties:
        contentType:
          type: string
        createdAt:
          type:
            - string
            - 'null'
        driver:
          type:
            - string
            - 'null'
        expiresAt:
          type:
            - string
            - 'null'
        filename:
          type: string
        id:
          type: string
          format: uuid
        logicalPath:
          type: string
        metadata:
          oneOf:
            - description: Any type
            - type: 'null'
        runtimeId:
          type:
            - string
            - 'null'
          format: uuid
        sizeBytes:
          type: integer
        source:
          type: string
        target:
          type:
            - string
            - 'null'
        workspace:
          type: string
      required:
        - contentType
        - createdAt
        - driver
        - expiresAt
        - filename
        - id
        - logicalPath
        - metadata
        - runtimeId
        - sizeBytes
        - source
        - target
        - workspace
      title: V1StorageObjectsGetResponsesContentApplicationJsonSchemaObjectsItems
    storage_objectsList_Response_200:
      type: object
      properties:
        objects:
          type: array
          items:
            $ref: >-
              #/components/schemas/V1StorageObjectsGetResponsesContentApplicationJsonSchemaObjectsItems
      required:
        - objects
      title: storage_objectsList_Response_200
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v1/storage/objects"

querystring = {"workspace":"project-alpha","runtimeId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","source":"user-upload","driver":"s3","target":"archive","pathPrefix":"images/2024/","limit":"50","offset":"0"}

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.bctrl.ai/v1/storage/objects?workspace=project-alpha&runtimeId=3fa85f64-5717-4562-b3fc-2c963f66afa6&source=user-upload&driver=s3&target=archive&pathPrefix=images%2F2024%2F&limit=50&offset=0';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bctrl.ai/v1/storage/objects?workspace=project-alpha&runtimeId=3fa85f64-5717-4562-b3fc-2c963f66afa6&source=user-upload&driver=s3&target=archive&pathPrefix=images%2F2024%2F&limit=50&offset=0"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.bctrl.ai/v1/storage/objects?workspace=project-alpha&runtimeId=3fa85f64-5717-4562-b3fc-2c963f66afa6&source=user-upload&driver=s3&target=archive&pathPrefix=images%2F2024%2F&limit=50&offset=0")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.bctrl.ai/v1/storage/objects?workspace=project-alpha&runtimeId=3fa85f64-5717-4562-b3fc-2c963f66afa6&source=user-upload&driver=s3&target=archive&pathPrefix=images%2F2024%2F&limit=50&offset=0")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.bctrl.ai/v1/storage/objects?workspace=project-alpha&runtimeId=3fa85f64-5717-4562-b3fc-2c963f66afa6&source=user-upload&driver=s3&target=archive&pathPrefix=images%2F2024%2F&limit=50&offset=0', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v1/storage/objects?workspace=project-alpha&runtimeId=3fa85f64-5717-4562-b3fc-2c963f66afa6&source=user-upload&driver=s3&target=archive&pathPrefix=images%2F2024%2F&limit=50&offset=0");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v1/storage/objects?workspace=project-alpha&runtimeId=3fa85f64-5717-4562-b3fc-2c963f66afa6&source=user-upload&driver=s3&target=archive&pathPrefix=images%2F2024%2F&limit=50&offset=0")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```