Get Connection

gethttps://api.flxpoint.com/connections/{id}

Use this when you want to pull connection data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

Endpoint to retrieve back a Connection by ID.

Requires Account-level privileges.

Request

Example request

get/connections/{id}

curl -X GET "https://api.flxpoint.com/connections/{id}" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN"

Responses

200OKapplication/json

idinteger

connectionTypestring

connectionTypeIdinteger

connectionTypeNamestring

requiresConnectionToTestbooleandeprecated

namestring

configsarray[ConnectionConfig]

handlestring

namestring

requiredboolean

editableboolean

dataTypestring

defaultValuestring

optionsarray[ConnectionConfigOption]

valuestring

labelstring

advancedboolean

valuestring

hiddenboolean

descriptionstring

sortOrderinteger

Example response

{
  "id": 0,
  "connectionType": "string",
  "connectionTypeId": 0,
  "connectionTypeName": "string",
  "requiresConnectionToTest": true,
  "name": "string",
  "configs": [
    {
      "handle": "string",
      "name": "string",
      "required": true,
      "editable": true,
      "dataType": "string",
      "defaultValue": "string",
      "options": [
        {
          "value": null,
          "label": null
        }
      ],
      "advanced": true,
      "value": "string",
      "hidden": true,
      "description": "string",
      "sortOrder": 0
    }
  ]
}

401Unauthorized

No schema documented for this status.

404Connection Not Found

No schema documented for this status.

OpenAPI fragment

{
  "get": {
    "summary": "Get Connection",
    "description": "Endpoint to retrieve back a Connection by ID. \n\nRequires Account-level privileges. ",
    "parameters": [],
    "responses": {
      "200": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Connection"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized"
      },
      "404": {
        "description": "Connection Not Found"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight