List

List

client.Directories.List(ctx, query) (*ExpandedarrayListarrayNextPageTokenstringDirectoryListResponse, error)

get/api/v1/directories

List directories.

Parameters

queryPageSizefieldPageTokenfieldDirectoryListParams

Hide ParametersShow Parameters

PageSizefield

optional

param.Field[int64]

The pageSize field.

formatint32

PageTokenfield

optional

param.Field[string]

The pageToken field.

Returns

DirectoryListResponsestruct

The DirectoryServiceListResponse message contains a list of results and a nextPageToken if applicable.

Hide ParametersShow Parameters

Expandedarray

optional

[]DirectoryListResponseExpanded

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

Listarray

optional

[]AppPathstringDirectoryDirectoryViewDirectoryDirectoryView

The list of results containing up to X results, where X is the page size defined in the request.

Hide ParametersShow Parameters

AppPathstring

optional

JSONPATH expression indicating the location of the App object in the array.

DirectoryAppIDstringCreatedAtTimeDeletedAtTimeUpdatedAtTimeDirectoryViewDirectory

optional

This object indicates that an app is also a directory.

Hide ParametersShow Parameters

AppIDstring

optional

The ID of the app associated with the directory.

CreatedAtTime

optional

formatdate-time

DeletedAtTime

optional

formatdate-time

UpdatedAtTime

optional

formatdate-time

NextPageTokenstring

optional

List of serialized related objects.

Request example Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  directories, err := client.Directories.List(context.TODO(), conductoronesdk.DirectoryListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", directories.Expanded)
}

200 Example

{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "appPath": "appPath",
      "directory": {}
    }
  ],
  "nextPageToken": "nextPageToken"
}