COconfluent
Organizations (org/v2)

List of Organizations

Changed on

General Availability

Retrieve a sorted, filtered, paginated list of all organizations.

get/org/v2/organizations

Request

  • Base URL
    https://api.confluent.cloud
  • URL
    https://api.confluent.cloud/org/v2/organizations
  • Auth
    • HTTP basic
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.confluent.cloud/sts/v1/oauth2/token

Query parameters

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Organization.

api_version'org/v2' required

APIVersion defines the schema version of this representation of a resource.

kind'OrganizationList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/org/v2/organizations",
    "last": "https://api.confluent.cloud/org/v2/organizations?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/org/v2/organizations?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/org/v2/organizations?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/org/v2/organizations/o-12345",
        "resource_name": "crn://confluent.cloud/organization=o-12345",
        "created_at": "2006-01-02T15:04:05-07:00",
        "updated_at": "2006-01-02T15:04:05-07:00",
        "deleted_at": "2006-01-02T15:04:05-07:00"
      },
      "display_name": "Finance Org"
    }
  ]
}

Changes

  • 83f5e4fbfe08Revision changes
    • info

      added the optional property ////////// to the response with the status