Get Connection

Retrieves detailed information about a specific connection. Unlike list operations, secret fields (passwords, API keys, etc.) are returned in full when getting a single connection.

​

Endpoint

GET /apiops/projects/{projectName}/connections/{connectionName}/

​

Authentication

Requires a Personal API Access Token.

​

Header

Authorization: Bearer YOUR_TOKEN

​

Request

​

Headers

Header	Value	Required
Authorization	Bearer	Yes

​

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
connectionName	string	Yes	Connection name

​

Query Parameters

None

​

Response

​

Success Response (200 OK)

{
  "success": true,
  "resultList": [
    {
      "type": "email",
      "name": "my-email-connection",
      "description": "Email connection for notifications",
      "deployToWorker": true,
      "enabled": true,
      "host": "smtp.gmail.com",
      "port": 587,
      "username": "[e-mail]",
      "password": "actual-password",
      "enableStartTls": true,
      "auth": true,
      "defaultEncoding": "UTF-8",
      "addressToTest": "[e-mail]",
      "from": "[e-mail]",
      "additionalProperties": []
    }
  ],
  "resultCount": 1
}

​

Response Fields

Field	Type	Description
success	boolean	Indicates if the request was successful
resultList	array	List containing single connection object
resultCount	integer	Always 1 for get operation

​

Connection Object Fields (Common)

Field	Type	Description
type	string	Connection type discriminator field. Identifies the connection type in API responses.
name	string	Connection name
description	string	Connection description
deployToWorker	boolean	Whether to deploy to worker
enabled	boolean	Whether connection is enabled

Note: Connection-specific fields vary by connection type. Secret fields are returned in full (not masked) when getting a single connection.

​

Error Response (400 Bad Request)

{
  "error": "bad_request",
  "error_description": "Connection name can not be empty!"
}

​

Error Response (401 Unauthorized)

{
  "error": "unauthorized_client",
  "error_description": "Invalid token"
}

​

Error Response (404 Not Found)

{
  "error": "not_found",
  "error_description": "Connection (name: my-email-connection) was not found!"
}

​

cURL Example

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/connections/my-email-connection/" \
  -H "Authorization: Bearer YOUR_TOKEN"

​

Full JSON Body Example

This endpoint does not require a request body.

​

Notes and Warnings

• Secret Fields: Unlike list operations, secret fields (password, apiKey, etc.) are returned in full when getting a single connection
• Security: Never log or expose connection responses containing secrets
• Connection Types: Each connection type has different fields. See individual connection type documentation for details:
  • Email Connection
  • Kafka Connection
  • Database Connection
  • … (see Connections Index for complete list)

​

Related Documentation

• List Connections - List all connections (secrets masked)
• Create Connection - Create a new connection
• Update Connection - Update a connection
• Delete Connection - Delete a connection
• Email Connection - Email connection details