List publishing connectors

GET/v1/connectors

Destinations documents can be published to, with their auth methods, the settings a connection needs and the config a publication takes (JSON Schema), and what they can do.

docs:readRead-only

Request

curl "https://api.lydie.co/v1/connectors" \
  -H "Authorization: Bearer $LYDIE_TOKEN"

Response

connectorsConnectorInfo[]
Show 7 fieldsHide fields
- idstring
- namestring
- descriptionstring
- authobject[]
  Show 4 fieldsHide fields
  typestring
  One oftokenoauth2generated
  labelstring
  fieldsobjector null
  JSON Schema of the credentials to type in.
  availableboolean
  false: OAuth is not configured on this server.
- settingsSchemaobject
- configSchemaobject
- capabilitiesobject
  Show 8 fieldsHide fields
  formatstring
  One ofmarkdownhtmljson
  remoteStateboolean
  pullboolean
  conflictsstring
  One ofpullRequestdivergenone
  assetsstring
  One offilesuploadlink
  unpublishstring
  One ofdeletedraftnotify
  draftsboolean
  scheduleboolean

200

{
  "connectors": [
    {
      "id": "string",
      "name": "Notes",
      "description": "string",
      "auth": [
        {
          "type": "token",
          "label": null,
          "fields": null,
          "available": null
        }
      ],
      "settingsSchema": {},
      "configSchema": {},
      "capabilities": {
        "format": "markdown",
        "remoteState": false,
        "pull": false,
        "conflicts": "pullRequest",
        "assets": "files",
        "unpublish": "delete",
        "drafts": false,
        "schedule": false
      }
    }
  ]
}

Errors use one envelope for every endpoint. See Errors and versions.