Skip to main content

ListResponse[ConnectorSummaryResponse]

Paginated response containing Connector Summary Response records. The required field is items.

items object[]required

List of resource items

  • Array [
    • idId (string)required

    Server-assigned unique identifier

    nameName (string)required

    Resource name

    alias object

    URL-safe short handle

    anyOf
    string
    categoryCategory (string)required

    Resource type tag

    typeType (string)required
    collection_id object

    Parent collection ID

    anyOf
    string
    folder_id object

    Identifier of the containing folder.

    anyOf
    string
    tags object

    Classification labels

    anyOf
  • Array [
    • string
  • ]
    • description object

    Resource description

    anyOf
    string
    markingsstring[]

    Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

    Default value: []
    created_at object

    Creation timestamp (Unix ms)

    anyOf
    integer
    updated_at object

    Last update timestamp (Unix ms)

    anyOf
    integer
    owners object[]

    Users and groups that own the resource.

  • Array [
    • idId (string)required

    "user." | "group." | "public.all"

    typeType (string)required

    Possible values: [user, group, public]

    display_nameDisplay Name (string)required
    avatar_url object
    anyOf
    string
    avatar_config object
    anyOf
    object
    email object
    anyOf
    string<email>
  • ]
    • my_share_scope object

    How the current caller received access to the resource.

    anyOf
    string

    Possible values: [owner, grant, admin]

    is_builtinIs Builtin (boolean)

    Whether this is a platform-provided built-in

    Default value: false
    driver object
    anyOf
    string
    packagesstring[]

    Required Python packages

    Default value: []
    metadata object
    anyOf
    object
    itemItem (string)requireddeprecated
  • ]
    • next_cursor object

    Cursor for next page

    anyOf
    string
    has_moreHas More (boolean)

    Whether more pages exist

    Default value: false
    ListResponse[ConnectorSummaryResponse]
    {
      "items": [
        {
          "id": "string",
          "name": "string",
          "alias": "string",
          "category": "string",
          "type": "string",
          "collection_id": "string",
          "folder_id": "string",
          "tags": [
            "string"
          ],
          "description": "string",
          "markings": [
            "string"
          ],
          "created_at": 0,
          "updated_at": 0,
          "owners": [
            {
              "id": "string",
              "type": "user",
              "display_name": "string",
              "avatar_url": "string",
              "avatar_config": {},
              "email": "user@example.com"
            }
          ],
          "my_share_scope": "owner",
          "is_builtin": false,
          "driver": "string",
          "packages": [
            "string"
          ],
          "metadata": {}
        }
      ],
      "next_cursor": "string",
      "has_more": false
    }