Skip to content
Product Docs

List Organizations

client.Organizations.List(ctx, query) (*PaginatedCursor[Organization], error)
GET/api/v2/organizations

List organizations the current user can access.

ParametersExpand Collapse
query OrganizationListParams
Name param.Field[string]Optional
PageSize param.Field[int64]Optional
PageToken param.Field[string]Optional
ReturnsExpand Collapse
type Organization struct{…}

API response schema for an organization.

ID string

The organization’s unique identifier.

Name string

The organization’s display name.

CreatedAt TimeOptional

Creation datetime

formatdate-time
Metadata map[string, any]Optional

Additional organization metadata.

UpdatedAt TimeOptional

Update datetime

formatdate-time

List Organizations

package main

import (
  "context"
  "fmt"

  "github.com/run-llama/llamacloud-admin-go"
  "github.com/run-llama/llamacloud-admin-go/option"
)

func main() {
  client := llamacloudadmin.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Organizations.List(context.TODO(), llamacloudadmin.OrganizationListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
{
  "items": [
    {
      "id": "id",
      "name": "name",
      "created_at": "2019-12-27T18:11:19.117Z",
      "metadata": {
        "foo": "bar"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "name": "name",
      "created_at": "2019-12-27T18:11:19.117Z",
      "metadata": {
        "foo": "bar"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}