Skip to main content

Get specific connector

GET 
/v2/boards/:board_id/connectors/:connector_id

Retrieves information for a specific connector on a board.

Required scope

boards:read

Rate limiting

Level 1

Request​

Path Parameters

    board_id stringrequired

    Unique identifier (ID) of the board from which you want to retrieve a specific connector.

    connector_id stringrequired

    Unique identifier (ID) of the connector that you want to retrieve.

Responses​

Connector retrieved

Schema

    captions

    object[]

    Blocks of text you want to display on the connector.

  • Array [

    • content stringrequired

    Possible values: <= 200 characters

    The text you want to display on the connector. Supports inline HTML tags.

    position string

    The relative position of the text on the connector, in percentage, minimum 0%, maximum 100%. With 50% value, the text will be placed in the middle of the connector line. Default: 50%

    textAlignVertical string

    Possible values: [top, middle, bottom]

    The vertical position of the text on the connector. Default: middle

  • ]

    • createdAt date-time

    Date and time when the connector was created.
    Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    createdBy

    object

    Contains information about the user who created the item.

    id string

    Unique identifier (ID) of the user.

    type string

    Indicates the type of object returned. In this case, type returns user.

    endItem

    object

    The starting point of the connector.

    id string

    Unique identifier (ID) of the item the connector is attached to.

    links

    object

    Contains applicable links for the current object.

    self string

    Link to obtain more information about the current object.

    position

    object

    The relative position of the point on an item where the connector is attached. Position with x=0% and y=0% correspond to the top-left corner of the item, x=100% and y=100% correspond to the right-bottom corner.

    x string

    X-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

    y string

    Y-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

    id stringrequired

    Unique identifier (ID) of a connector.

    isSupported boolean

    Indicates whether the connector is supported at the moment. If this parameter returns false, we do not support the connector at the moment. We do not allow updates for unsupported connectors and we might not return all data about the connector, such as intermediate points and connection points to the canvas.

    links

    object

    Contains applicable links for the current object.

    self string

    Link to obtain more information about the current object.

    modifiedAt date-time

    Date and time when the connector was last modified.
    Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    modifiedBy

    object

    Contains information about the user who last modified the item.

    id string

    Unique identifier (ID) of the user.

    type string

    Indicates the type of object returned. In this case, type returns user.

    shape string

    Possible values: [straight, elbowed, curved]

    Default value: curved

    The path type of the connector line, defines curvature. Default: curved.

    startItem

    object

    The starting point of the connector.

    id string

    Unique identifier (ID) of the item the connector is attached to.

    links

    object

    Contains applicable links for the current object.

    self string

    Link to obtain more information about the current object.

    position

    object

    The relative position of the point on an item where the connector is attached. Position with x=0% and y=0% correspond to the top-left corner of the item, x=100% and y=100% correspond to the right-bottom corner.

    x string

    X-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

    y string

    Y-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

    style

    object

    Contains information about the style of a connector, such as the color or caption font size

    color string

    Hex value representing the color for the captions on the connector. Default: #1a1a1a

    endStrokeCap string

    Possible values: [none, stealth, diamond, filled_diamond, oval, filled_oval, arrow, triangle, filled_triangle, erd_one, erd_many, erd_only_one, erd_zero_or_one, erd_one_or_many, erd_zero_or_many]

    The decoration cap of the connector end, like an arrow or circle. Default: stealth.

    fontSize string

    Possible values: >= 10 and <= 288

    Defines the font size, in dp, for the captions on the connector. Default: 14

    startStrokeCap string

    Possible values: [none, stealth, diamond, filled_diamond, oval, filled_oval, arrow, triangle, filled_triangle, erd_one, erd_many, erd_only_one, erd_zero_or_one, erd_one_or_many, erd_zero_or_many]

    The decoration cap of the connector end, like an arrow or circle. Default: none.

    strokeColor string

    Hex value of the color of the connector line. Default: #000000.

    strokeStyle string

    Possible values: [normal, dotted, dashed]

    The stroke pattern of the connector line. Default: normal.

    strokeWidth string

    Possible values: >= 1 and <= 24

    The thickness of the connector line, in dp. Default: 1.0.

    textOrientation string

    Possible values: [horizontal, aligned]

    The captions orientation relatively to the connector line curvature. Default: aligned.

    type string

    Type of board object that is returned.

Loading...