Skip to content
Product Docs

List Organizations

OrganizationListPage organizations().list(OrganizationListParamsparams = OrganizationListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/api/v2/organizations

List organizations the current user can access.

ParametersExpand Collapse
OrganizationListParams params
Optional<String> name
Optional<Long> pageSize
Optional<String> pageToken
ReturnsExpand Collapse
class Organization:

API response schema for an organization.

String id

The organization’s unique identifier.

String name

The organization’s display name.

Optional<LocalDateTime> createdAt

Creation datetime

formatdate-time
Optional<Metadata> metadata

Additional organization metadata.

Optional<LocalDateTime> updatedAt

Update datetime

formatdate-time

List Organizations

package ai.llamaindex.llamacloudadmin.example;

import ai.llamaindex.llamacloudadmin.client.LlamaCloudAdminClient;
import ai.llamaindex.llamacloudadmin.client.okhttp.LlamaCloudAdminOkHttpClient;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationListPage;
import ai.llamaindex.llamacloudadmin.models.organizations.OrganizationListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudAdminClient client = LlamaCloudAdminOkHttpClient.fromEnv();

        OrganizationListPage page = client.organizations().list();
    }
}
{
  "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
}