Sign in
Consumer Shares (cdx/v1)

List of Consumer Shares

General Availability

Retrieve a sorted, filtered, paginated list of all consumer shares.

get/cdx/v1/consumer-shares

Query parameters

shared_resourcestring

Filter a collection by a string search

Filter the results by exact match for shared_resource.

include_deletedboolean

Filter for whether this value is true or false.

Include deactivated shares

page_sizeinteger

A pagination size for collection requests.

page_tokenstring

An opaque pagination token for collection requests.

Response

Consumer Share.

api_version'cdx/v1' required

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

kind'ConsumerShareList' required

Kind defines the object this REST resource represents.

Example response

{
  "metadata": {
    "first": "https://api.confluent.cloud/cdx/v1/consumer-shares",
    "last": "https://api.confluent.cloud/cdx/v1/consumer-shares?page_token=bcAOehAY8F16YD84Z1wT",
    "prev": "https://api.confluent.cloud/cdx/v1/consumer-shares?page_token=YIXRY97wWYmwzrax4dld",
    "next": "https://api.confluent.cloud/cdx/v1/consumer-shares?page_token=UvmDWOB1iwfAIBPj6EYb",
    "total_size": 123
  },
  "data": [
    {
      "id": "dlz-f3a90de",
      "metadata": {
        "self": "https://api.confluent.cloud/cdx/v1/consumer-shares/cs-12345",
        "resource_name": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/consumer-share=cs-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"
      },
      "provider_organization_name": "Nasdaq",
      "provider_user_name": "Jane Doe",
      "invite_expires_at": "2006-01-02T15:04:05-07:00",
      "consumer_organization_name": "Nasdaq",
      "consumer_user_name": "John Doe",
      "status": {
        "phase": "ACTIVE"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.