ConnectorResponse

Data returned for Connector. Required fields are id, name, category, type, item.

idId (string)required

Server-assigned unique identifier

nameName (string)required

Resource name

alias object

URL-safe short handle

anyOf

• string
• null

string

categoryCategory (string)required

Resource type tag

typeType (string)required

collection_id object

Parent collection ID

anyOf

• string
• null

string

folder_id object

Identifier of the containing folder.

anyOf

• string
• null

string

tags object

Classification labels

anyOf

• string[]
• null

Array [

string

]

description object

Resource description

anyOf

• string
• null

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
• null

integer

updated_at object

Last update timestamp (Unix ms)

anyOf

• integer
• null

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
• null

string

avatar_config object

anyOf

• object
• null

object

email object

anyOf

• string<email>
• null

string<email>

]

my_share_scope object

How the current caller received access to the resource.

anyOf

• string
• null

string

Possible values: [owner, grant, admin]

is_builtinIs Builtin (boolean)

Whether this is a platform-provided built-in

Default value: false

driver object

Bound native driver id, or null for a script-defined connector.

anyOf

• string
• null

string

options object

property name*any

Default value: {}

scriptScript (string)

Connector script

Default value:

packagesstring[]

Required Python packages

Default value: []

metadata object

anyOf

• object
• null

object

credential_status object

property name* object

property name*any

itemItem (string)requireddeprecated

ConnectorResponse

{
  "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",
  "options": {},
  "script": "",
  "packages": [
    "string"
  ],
  "metadata": {},
  "credential_status": {}
}