Skip to main content
GET
/
v3
/
connection
/
definitions
/
{definition}
Read Connection Definition
curl --request GET \
  --url http://localhost/api/v3/connection/definitions/{definition}
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "short_description": "<string>",
    "description": "<string>",
    "icon": "<string>",
    "cover": "<string>",
    "internal_notes": "<string>",
    "type": "<string>",
    "tenant": "<string>",
    "start_date_global": "<string>",
    "end_date_global": "<string>",
    "end_date_duration": 123,
    "meta": [
      "<unknown>"
    ],
    "shareable_attributes": [
      "<unknown>"
    ],
    "connector_condition": [
      "<unknown>"
    ],
    "connected_condition": [
      "<unknown>"
    ],
    "connector_can_break": true,
    "connected_can_break": true,
    "is_published": true,
    "is_pending": true,
    "is_archived": true,
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

definition
integer
required

The definition ID

Response

ConnectionDefinition

data
ConnectionDefinition · object
required